add documentation

godcrampy · Apr 25, 2020 · a06309a · a06309a
1 parent db39194
commit a06309a
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -0,0 +1,32 @@
+# Git Stalker
+
+Stalk GitHub users without leaving your terminal.
+
+![demo](docs/git-stalk.gif)
+
+## Install
+
+```bash
+$ npm i -g git-stalker
+
+# or using yarn
+
+$ yarn global add git-stalker
+```
+
+## Usage
+
+```bash
+$ stalk <username>
+
+# For example
+$ stalk godcrampy
+```
+
+## Authors
+
+- **Sahil Bondre** - [godcrampy](https://github.com/godcrampy)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
diff --git a/docs/git-stalk.gif b/docs/git-stalk.gif
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "git-stalker",
   "version": "1.0.0",
-  "description": "Stalk github users without leaving the terminal",
+  "description": "Stalk GitHub users without leaving your terminal",
   "main": "./dist/cli.js",
   "bin": {
     "stalk": "./dist/cli.js"