Update documentation for new split, fixes #8.
commited103e5dcf61e0054ea3455a39369c3800ebf22b
authorAntoine Latter <aslatter@gmail.com>
dateSun 22 Mar 2015, 16:04 (12 years ago)
parentf830a22
Policy.mdnew file+11
@@ -0,0 +1,11 @@
1+# Versioning
2+
3+Because many consumers of the `UUID` type receive the type
4+through the `uuid` package and not the `uuid-types` package
5+we need to be careful about removing instances from the `uuid`
6+type.
7+
8+If the `uuid-types` package has a major-version bump because of
9+the removal of a class instance then we must also bump the major
10+version of the `uuid` package when we update the package
11+description to pull in the new version of `uuid-types`.
README.md+8
@@ -2,3 +2,11 @@
22
33This library is useful for creating, comparing, parsing and printing Universally
44Unique Identifiers. See http://en.wikipedia.org/wiki/UUID for the general idea.
5+
6+We offer two different packages: `uuid` and `uuid-types`
7+
8+The `uuid` package aims to be a fully-featured library for working with UUIDs.
9+
10+However if you're developing a library and only want the `UUID` type to show up
11+in your APIs you may want to use the `uuid-types` library to minimize the number
12+of dependencies needed by users of your library.