Skip to content

Commit

Permalink
Update documentation for new split, fixes haskell-hvr#8.
Browse files Browse the repository at this point in the history
  • Loading branch information
aslatter committed Mar 22, 2015
1 parent f830a22 commit ed103e5
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
11 changes: 11 additions & 0 deletions Policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Versioning

Because many consumers of the `UUID` type receive the type
through the `uuid` package and not the `uuid-types` package
we need to be careful about removing instances from the `uuid`
type.

If the `uuid-types` package has a major-version bump because of
the removal of a class instance then we must also bump the major
version of the `uuid` package when we update the package
description to pull in the new version of `uuid-types`.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,11 @@

This library is useful for creating, comparing, parsing and printing Universally
Unique Identifiers. See http://en.wikipedia.org/wiki/UUID for the general idea.

We offer two different packages: `uuid` and `uuid-types`

The `uuid` package aims to be a fully-featured library for working with UUIDs.

However if you're developing a library and only want the `UUID` type to show up
in your APIs you may want to use the `uuid-types` library to minimize the number
of dependencies needed by users of your library.

0 comments on commit ed103e5

Please sign in to comment.