Maintaining static HTML files for displaying release notes in your project's software updater can be a chore, particularly if your code and release notes are hosted separately. If your project is hosted on GitHub however, you may already be using GitHub Releases, in which case you're already halfway to solving the problem. Wouldn't it be great if you could show those same release notes in your updater, without the unnecessary GitHub interface?
Enter releases.io.
The following libraries and technologies have made releases.io
possible:
- Sinatra by Blake Mizerany
- Thin by Marc-André Cournoyer
- RedCarpet by Vicent Martí
- JSON implementation for Ruby by Florian Frank
- Haml by The Haml Team
releases.io
is provided under the terms of the MIT License.
If you would like to contribute to the project, start by forking the repository on GitHub, then go ahead and make your code changes. When you're done, submit a pull request with a brief description of your feature or bug fix.
You can also contribute to the ongoing costs involved in providing the service by making a small cash donation via Gratipay.
Email me at marc.ransome@fidgetbox.co.uk or create an issue.