Skip to content

Commit

Permalink
Clarify Function
Browse files Browse the repository at this point in the history
This isn't a uuid generator... not yet, anyway.
  • Loading branch information
Samuel Rouse authored Jun 10, 2016
1 parent 84b5d5d commit c366a8a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![Code Climate](https://codeclimate.com/github/oculus42/short-uuid/badges/gpa.svg)](https://codeclimate.com/github/oculus42/short-uuid)
[![Test Coverage](https://codeclimate.com/github/oculus42/short-uuid/badges/coverage.svg)](https://codeclimate.com/github/oculus42/short-uuid/coverage)

Translate standard UUIDs into shorter formats and back.
Translate standard UUIDs into shorter (or just different) formats and back. This library does not *generate* UUIDs, just convert them. I recommend [node-uuid](https://www.npmjs.com/package/node-uuid) for that.

var shortUUID = require('short-uuid')

Expand Down

0 comments on commit c366a8a

Please sign in to comment.