readme

readme.md

@@ -1,11 +1,25 @@
 
 Utility for generating Snowflake UIDs (see: <https://en.wikipedia.org/wiki/Snowflake_ID>)
 
+Features:
+
+- **Zero** dependencies
+- Configurable epoch time
+- Configurable instance size, allowing timestamp and sequence to be larger
+
 ---
 
 ## Install
 
-<!--  -->
+```bash
+# Update project npm config to refer to correct registry for the @js scope
+echo '@js:registry=https://gitea.jbrumond.me/api/packages/js/npm/' >> ./.npmrc
+
+npm install --save @js/snowflake-uid
+
+# optional - additional supporting typescript definitions
+npm install --save-dev @js/types
+```