Add install instruction

short-d · Aug 5, 2019 · 003de57 · 003de57
1 parent b45f960
commit 003de57
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,29 @@
 # Short Ext
 Chrome extension for [Short](https://github.com/byliuyang/short)
 
+## Preview
+![](doc/usage.gif)
+
+## Prerequisites
+- yarn v1.17.3
+- node v12.3.1
+
+## Getting Started
+### Build
+```bash
+./bin/build.sh
+```
+
+### Install
+1. Navigate to `chrome://extensions/` in Google Chrome.
+2. Turn on `developer mode`.
+![](doc/screenshot/developer-mode.png)
+3. Click on `Load unpacked`.
+![](doc/screenshot/load-unpacked.png)
+4. Select `build` directory.
+5. **Short** should now up in extension list.
+![](doc/screenshot/extension.png)
+
 ## Author
 Harry Liu - [byliuyang](https://github.com/byliuyang)
 

diff --git a/doc/screenshot/developer-mode.png b/doc/screenshot/developer-mode.png
diff --git a/doc/screenshot/extension.png b/doc/screenshot/extension.png
diff --git a/doc/screenshot/load-unpacked.png b/doc/screenshot/load-unpacked.png
diff --git a/doc/usage.gif b/doc/usage.gif