From 255a8247d7e8871e4a2ccb1216f490bb4e8ca5f8 Mon Sep 17 00:00:00 2001
From: Mark Mankarious <mz.mankarious@gmail.com>
Date: Thu, 23 Mar 2023 22:36:34 +0000
Subject: [PATCH] chore: updates README

---
 README.md | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 4462dd3..4ab2f21 100644
--- a/README.md
+++ b/README.md
@@ -24,12 +24,35 @@ Migration to open-source: ██░░░░░░░░░
 
 - [x] Set up automated publishing to NPM registry
 - [ ] Migrate private JS project to public Typescript project
-  - [ ] Pan / Select / Zoom modes
-  - [ ] Icons
+  - [x] Pan / Select / Zoom modes
+  - [x] Display icons in sidebar
+  - [ ] Nodes
   - [ ] Groups
   - [ ] Connectors
 - [ ] Publish icons as separate importable package
 
+## Installation
+
+Note: Isoflow is currently not production ready. To view it's current state of development:
+
+`npm install isoflow`
+
+```
+import Isoflow from 'isoflow';
+
+const App = () => (
+  <Isoflow
+    height={500}
+    initialScene={{
+      icons: [],
+      nodes: [],
+      connectors: [],
+      groups: []
+    }}
+  >
+)
+```
+
 ## License
 
 Isoflow is MIT licensed (see ./LICENSE).