Use Git/Github releases instead of giant README

[Anahkiasen]

Currently new releases are rolled out through an ever-changing README. For notifications and management purposes it might be a better idea to use Git releases for that purpose.

Using a date-based version system in your case, a simple git tag 20160101 would work, and then in each release you can specify the changelog on Github. For those of us that watch the repo it would allow us to get notifications when new releases are available and know that we need to refresh the bookmarklet.

[genbtc]

Wow. I finally started this. https://github.com/zininzinin/AutoTrimps/releases I really wish I had taken your suggestion earlier. Can you please help me find my way with the new system ? I like that now we can refer the script to URLs with the version number in it, (in case i break something you can target the last stable release's URL).
About the README, I feel like these new releases/tags should be itemized on the README (since it's the front page new people see), is there a way we can add Releases's hyperlinks automatically ? OR do you have any repos to point me to that do this efficiently that i can model mine after? Or anything else.

[Anahkiasen]

Standard is usually to have a separate CHANGELOG.md file containing the release notes, with the header of each version pointing to the Github release (or a diff between that version and the last, depending on what you prefer). But in your case that could be done in the README.md itself. Although you would still need to copy/paste the release notes between your README and the Github release.

That being said the most important part is the Git tag, the Github release doesn't have to contain the release notes if they're already in the README, so you could pretty much have your changelog in your README like right now, just, with a link to each github release on each version.

More information on the KAC standard to write changelogs http://keepachangelog.com/en/0.3.0/

[Anahkiasen]

Also as a note you can tag Git commits retroactively, so you could still tag old releases if you wish so