doc: package name adjust

Kanaries · Sep 24, 2021 · 2f44a3b · 2f44a3b
1 parent 259b9be
commit 2f44a3b
Showing 1 changed file with 15 additions and 5 deletions.
diff --git a/packages/graphic-walker/README.md b/packages/graphic-walker/README.md
@@ -9,15 +9,19 @@ Main features:
 + A Data Explainer which explain some why some patterns occur / what may cause them.
 
 ## Usage
+
+### use as an embedding module
 ```bash
-cd graphic-waler
-yarn install
-npm run build
+yarn add @kanaries/graphic-walker
+
+# or
+
+npm i --save @kanaries/graphic-walker
 ```
 
 In your app:
 ```typescript
-import { GraphicWalker } from 'graphic-walker';
+import { GraphicWalker } from '@kanaries/graphic-walker';
 import 'graphic-walker/dist/style.css'
 
 const YourEmbeddingTableauStyleApp: React.FC = props => {
@@ -30,4 +34,10 @@ const YourEmbeddingTableauStyleApp: React.FC = props => {
 }
 
 export default YourEmbeddingTableauStyleApp;
-```
+```
+
+### try local
+```bash
+# packages/graphic-walker
+npm run dev
+```