‘Run on Staroid’ button

The ‘Run on Staroid’ button usually placed in README.md file in the opt of your Github repository. It helps users to launch your project from Github README page.

Here’s an example button

run on staroid button

Adding the button

Add following in your README.md. Staroid will automatically infer the repository URL from the referer header when someone clicks on the button.

[![Run](https://staroid.com/api/run/button.svg)](https://staroid.com/api/run)

Private Github repository

Run button works on both public and private Github repositories. However, private Github repository does not send referer header. So you must speficy a repo URL parameter in the button link.

[![Run](https://staroid.com/api/run/button.svg)](https://staroid.com/api/run?repo=https://github.com/staroids/private_repo)

Replace https://github.com/staroids/private_repo to your private Github repository address.