From 0f053e778723ee987ccff0964eda9f19f2f567a8 Mon Sep 17 00:00:00 2001
From: James Brumond <james@jbrumond.me>
Date: Sat, 26 Aug 2023 16:11:22 -0700
Subject: [PATCH] readme

---
 readme.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/readme.md b/readme.md
index 9a055a3..f08b392 100644
--- a/readme.md
+++ b/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
+```