doc: add CHANGELOG.md and update README.md with installing uuid

mernxl · Aug 11, 2018 · db646cf · db646cf
1 parent ad27369
commit db646cf
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+# Semantically Released 
+This packages' publishing is automated by [semantic-release](https://github.com/semantic-release/semantic-release).
+[Changelog](https://github.com/mernxl/mongoose-id-assigner/releases) is generated automatically and can be found here: https://github.com/mernxl/mongoose-id-assigner/releases
diff --git a/README.md b/README.md
@@ -36,6 +36,11 @@ or
 npm install mongoose-id-assigner
 ```
 
+If you wish to use `UUIDs` FieldTypes, then you need to add this package, `uuid`.
+```
+yarn add uuid
+```
+
 ## Basic Usage
 ### Plugin Options
 TypeName: **AssignerOptions**