README.md in sixarm_ruby_xid-3.1.0 vs README.md in sixarm_ruby_xid-3.2.0
- old
+ new
@@ -1,9 +1,9 @@
# SixArm.com » Ruby » <br> XID excellent identifier
-[](https://codeclimate.com/github/SixArm/xid)
-[](https://travis-ci.org/SixArm/xid)
+[](https://codeclimate.com/github/SixArm/sixarm_ruby_xid)
+[](https://travis-ci.org/SixArm/sixarm_ruby_xid)
* Doc: <http://sixarm.com/sixarm_ruby_xid/doc>
* Gem: <http://rubygems.org/gems/sixarm_ruby_xid>
* Repo: <http://github.com/sixarm/sixarm_ruby_xid>
* Email: Joel Parker Henderson, <joel@sixarm.com>
@@ -37,11 +37,11 @@
gem install sixarm_ruby_xid
Bundler:
- gem "sixarm_ruby_xid", ">=3.0.0", "<4"
+ gem "sixarm_ruby_xid", ">=3.1.0", "<4"
Require:
require "sixarm_ruby_xid"
@@ -61,12 +61,13 @@
## Details
Methods:
- * `XID.new`: generate a new XID string
- * `XID#digest`: return a SHA256 digest as a 64-character string
+ * `XID.new`: create an XID string initialized to a random string.
+ * `XID.new(s): create an XID initialized to the given string.
+ * `XID#digest`: return a SHA256 digest as a 64-character string.
Notes:
* XID uses Ruby's SecureRandom methods for strong security.
* An XID is a Ruby string, so you can do any string methods on it.
@@ -119,10 +120,11 @@
Some databases have specialize fields for 128 bit values, such as PostgreSQL and its UUID extensions. PostgreSQL states that a UUID field will accept a string that is lowercase and that omits dashes. PostgreSQL does not do any validity-checking on the UUID value. Thus it is viable to store an XID in a UUID field. Our team has a goal to create a PostgreSQL extension for the XID data type.
## Changes
-* 2015-02-11 3.0.0 Upgrade to XID
+* 2015-02-12 3.1.0 Add #digest.
+* 2015-02-11 3.0.0 Upgrade to XID.
* 2013-08-20 2.1.0 Add #next to enable using this as an enumeration.
* 2013-08-18 2.0.0 Upgrade for Ruby 2.0.0; add .length and .choices methods.
* 2012-03-21 1.4.0 Upgrade for Ruby 1.9.3, minitest/spec, and improved docs.
* 2011-04-22 1.3.0 Update to 32 characters
* 2011-04-21 1.2.2 End support for Ruby 1.8.6