README.md in iuid-0.0.2 vs README.md in iuid-0.0.3
- old
+ new
@@ -1,6 +1,7 @@
# iuid
+[![Build Status](https://travis-ci.org/duritong/iuid.png)](https://travis-ci.org/duritong/iuid)
iuid is a simple username / uid storage that can autogenerate uids.
iuid will either retrieve an existing uid for a category/key or generate the next available
uid. If this uid collides with a range of the next category an exception is raised.
@@ -15,11 +16,11 @@
### create
Assuming that we have an empty iuid storage.
- trocla create user1 category1
+ iuid create user1 category1
This will create (if not already stored in iuid) a random uid for the key
user1 and use category1 as a range information from which within a uid should
should be created.
@@ -51,12 +52,18 @@
This will delete the stored uid and return it.
## Installation
-Simply build and install the gem. BUT trocla is based on a not yet published
-version of [moneta](https://github.com/wycats/moneta). You can build a new
-moneta version based on the latest master as version 0.6.1 and instal that one.
+Simply build and install the gem.
+
+## Update & Changes
+
+### to 0.0.3
+
+1. be sure to update as well the moneta gem, trocla now uses the official moneta releases and supports current avaiable versions.
+1. Options for moneta's backends have changed. For example, if you are using the yaml-backend you will likely need to change the adapter option `:path:` to `:file:` to match moneta's new API.
+1. **IMPORTANT:** If you are using the yaml backend you need to migrate the current data *before* using the new trocla version! You can migrate the datastore by using the following two sed commands `sed -i 's/^ / /' /PATH/TO/trocla_data.yaml` && `sed -i '/^ value\:/d' /PATH/TO/trocla_data.yaml`.
## Contributing to iuid
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it