README.md in sixarm_ruby_xid-3.3.0 vs README.md in sixarm_ruby_xid-3.4.0
- old
+ new
@@ -1,6 +1,6 @@
-# SixArm.com » Ruby » <br> XID excellent identifier
+# Ruby » <br> XID excellent identifier
[](https://codeclimate.com/github/SixArm/sixarm_ruby_xid)
[](https://travis-ci.org/SixArm/sixarm_ruby_xid)
* Doc: <http://sixarm.com/sixarm_ruby_xid/doc>
@@ -63,12 +63,15 @@
Methods:
* `XID.new`: create an XID and initialize to a random string.
* `XID.new(s): create an XID and initialize to a given string.
+ * `XID.valid?`: is this XIDa valid, i.e. the correct format?
+ * `XID#valid?(s)`: is a string a valid XID, i.e. the correct format?
* `XID#digest`: return a SHA256 digest as a 64-character string.
* `XID.digest(s)`: return a SHA256 digest as a 64-character string.
+ * `XID.parse(s)`: parse any string with enough data to a new XID.
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.
@@ -121,9 +124,10 @@
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-04-01 3.4.0 Add XID.parse and XID.valid?
* 2015-02-12 3.3.0 Add XID.digest(s)
* 2015-02-12 3.2.0 Add XID.new(s) to initialize with a given string.
* 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.