A GitHub listing sends people to your public repository. It suits open source projects, developer tools and anything where the code is the product.
What you need
- A public repository. People who click through must be able to open it without being invited.
- A README that explains what the project does and how to run it.
Set it up
- Start a new listing or edit an existing one.
- Under how people get the app, choose GitHub.
- Paste the repository link, for example the address of the repo on github.com.
- Finish the rest of the listing and publish.
On the listing page the button reads Open on GitHub.
What visitors see
Visitors read your description and screenshots on Webdever, then follow the button to your repository. Webdever counts those clicks, and they show up in your activity dashboard as Downloads & clicks when you have a mix of listing types.
Make the repository ready
- Put install and run steps near the top of the README.
- Add a license so people know what they can do with the code.
- Pin a release or tag if you want people to start from a stable version.
- Keep the default branch healthy. Visitors judge the project by what they find there.
When to use something else
If people should receive a packaged build rather than browse source, use a ZIP package. If you would rather let people try the app before reading any code, add a live demo.