diff --git a/README.md b/README.md new file mode 100644 index 0000000..50a6651 --- /dev/null +++ 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 + +# 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 new file mode 100644 index 0000000..45a63d1 Binary files /dev/null and b/docs/git-stalk.gif differ diff --git a/package.json b/package.json index 88d7b27..c9a724c 100644 --- 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"