Update documentation text in README, move changelog to separate file

master
Sven Slootweg 8 years ago
parent 3cf4031fe1
commit 438e85336c

@ -0,0 +1,23 @@
## 1.0.0 (August 17, 2016)
First stable release - however, the functionality or API has not changed from `0.0.2`.
* __Documentation:__ Moved changelog to a separate file.
* __Documentation:__ Updated donation text.
* __Documentation:__ Added remark regarding licensing of contributions.
* __Package:__ Now following semantic versioning.
## 0.0.2 (January 12, 2015)
* __Minor:__ More exposed API methods: `getFlagMap`, `getFlags` and `getInheritedFlags`.
* __Patch:__ Rearranged some code, to put it in a more sensible place.
* __Patch:__ Fixed a typo in an error message.
* __Documentation:__ Added a changelog.
* __Documentation:__ Added API documentation.
* __Documentation:__ Clarified the flag inheritance example.
* __Package:__ Changed repository URL to point at the GitHub mirror.
* __Package:__ Fixed module name.
## 0.0.1 (January 12, 2015)
Initial release.

@ -10,9 +10,9 @@ While the examples in this documentation will show usage for a permission system
## Donate ## Donate
My income consists entirely of donations for my projects. If this module is useful to you, consider [making a donation](http://cryto.net/~joepie91/donate.html)! Maintaining open-source projects takes a lot of time, and the more donations I receive, the more time I can dedicate to open-source. If this module is useful to you, consider [making a donation](http://cryto.net/~joepie91/donate.html)!
You can donate using Bitcoin, PayPal, Gratipay, Flattr, cash-in-mail, SEPA transfers, and pretty much anything else. You can donate using Bitcoin, PayPal, Flattr, cash-in-mail, SEPA transfers, and pretty much anything else. Thank you!
## Contributing ## Contributing
@ -181,16 +181,4 @@ It is the value that you will pass to `flagHandler.create([initialValue, [initia
Returns an array of all the flags (names, not values) that are set in the current value, both explicit and inherited. Returns an array of all the flags (names, not values) that are set in the current value, both explicit and inherited.
*You probably won't need this, unless you're trying to debug something.* *You probably won't need this, unless you're trying to debug something.*
## Changelog
### v0.0.2
* More exposed API methods: `getFlagMap`, `getFlags` and `getInheritedFlags`.
* Documentation update; now with a full API documentation and a changelog!
* Shuffled around some functions, so that they are in a sensible place.
### v0.0.1
Initial release.
Loading…
Cancel
Save