Use Github Release Structure or CHANGELOG

iamMehedi / Secured-Preference-Store

A cryptography library and a SharedPreferences wrapper for Android that encrypts the content with 256 bit AES encryption. The Encryption key is securely stored in device's KeyStore.

562 stars 97 forks source link

Use Github Release Structure or CHANGELOG #16

Closed StuStirling closed 6 years ago

StuStirling commented 6 years ago

It would be useful to have a CHANGELOG.md in the project's root or to use Github's release tagging feature to keep track of the different changes between versions.

For example the recent addition of the init method is a breaking change and would be useful if it was more obvious that it was added.

iamMehedi commented 6 years ago

Release tags work better in my opinion.

iamMehedi commented 6 years ago

tag v0.5.0 has been added.