update doc

Author: Russian Reboucas

README.md

@@ -1,15 +1,7 @@
-## Installation:
+# Git Semantic Commit Messages
 
-1. Clone this repo, prefferably in your $HOME directory.
-``` git clone https://github.com/russiann/git-semantic-commits ~/.git-semantic-commits ```
-
-2. Add the folder to your $PATH.
-  * if using Bash, open ```~/.bashrc``` with your favourite editor and add this line: <br/> ``` export PATH=$PATH:$HOME/.git-semantic-commits:$PATH ```
-  * if using Zsh, open ```~/.zshrc``` with your favourite editor and add this line: <br/>  ``` export PATH=$PATH:$HOME/.git-semantic-commits:$PATH ```
-
-3. Save the file and source the changes in bashrc/zshrc: ```source ~/.bashrc``` or ```source ~/.zshrc```
-
-4. Done!
+This project is based on [Karma Git Commit Convention](http://karma-runner.github.io/1.0/dev/git-commit-msg.html).
+See their commit history for examples of properly-formatted commit messages.
 
 ### Commands:
 
@@ -31,3 +23,25 @@
 | `git test <scope> <message>`      | test(scope): message            |
 | `git localize <message>`          | localize: message               |
 | `git localize <scope> <message>`  | localize(scope): message        |
+
+
+## Manual Installation:
+
+1. Clone this repo, prefferably in your $HOME directory.
+```
+git clone https://github.com/russiann/git-semantic-commits ~/.git-semantic-commits
+```
+
+2. Add the folder to your $PATH.
+  * if using Bash, open ```~/.bashrc``` with your favourite editor and add this line:
+  ```
+  export PATH=$PATH:$HOME/.git-semantic-commits:$PATH
+  ```
+  * if using Zsh, open ```~/.zshrc``` with your favourite editor and add this line:
+  ```
+  export PATH=$PATH:$HOME/.git-semantic-commits:$PATH
+  ```
+
+3. Save the file and source the changes in bashrc/zshrc: ```source ~/.bashrc``` or ```source ~/.zshrc```
+
+4. Done!

install.sh

@@ -0,0 +1,45 @@
+# !/bin/bash
+export PATH=$PATH:$HOME/.git-semantic-commits:$PATH
+bashrc=$HOME"/.bashrc"
+zshrc=$HOME"/.zshrc"
+
+packageDir=$(pwd)
+
+if [ -f "$bashrc" ]
+then
+	echo "Installing on Bash"
+  dir="export PATH=$PATH:$HOME/.git-semantic-commits:$PATH"
+
+  echo "" >> $zshrc
+  echo "#git-semantic-commits (delete this lines to 'uninstall' commands)" >> $bashrc
+  echo $dir >> $bashrc
+else
+	echo ""
+fi
+
+if [ -f "$zshrc" ]
+then
+	echo "Installing on ZSH"
+  dir="export PATH=$PATH:$packageDir:$PATH"
+
+  echo "" >> $zshrc
+  echo "#git-semantic-commits (delete this lines to 'uninstall' commands)" >> $zshrc
+  echo $dir >> $zshrc
+else
+	echo ""
+fi
+echo "-------------------------------------------------"
+
+echo "╔═╗╦╔╦╗  ╔═╗╔═╗╔╦╗╔═╗╔╗╔╔╦╗╦╔═╗  ╔═╗╔═╗╔╦╗╔╦╗╦╔╦╗
+║ ╦║ ║   ╚═╗║╣ ║║║╠═╣║║║ ║ ║║    ║  ║ ║║║║║║║║ ║
+╚═╝╩ ╩   ╚═╝╚═╝╩ ╩╩ ╩╝╚╝ ╩ ╩╚═╝  ╚═╝╚═╝╩ ╩╩ ╩╩ ╩ "
+
+echo ""
+echo "Installation complete!"
+echo ""
+echo "Follow the instructions below:"
+echo ""
+echo "For Bash run: source ~/.bashrc"
+echo "For ZSH run: source ~/.zshrc"
+echo ""
+echo "Or restart your terminal!"

package.json

@@ -0,0 +1,30 @@
+{
+  "name": "git-semantic-commits",
+  "version": "1.0.1",
+  "description": "Semantic Commits Msg for GIT",
+  "main": "index.js",
+  "scripts": {
+    "postinstall": "./install.sh",
+    "preuninstall": "./uninstall.sh"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/russiann/git-semantic-commits.git"
+  },
+  "keywords": [
+    "git",
+    "commit",
+    "semantic",
+    "karma",
+    "message",
+    "commits",
+    "convention",
+    "pattern"
+  ],
+  "author": "Russian Rebouças",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/russiann/git-semantic-commits/issues"
+  },
+  "homepage": "https://github.com/russiann/git-semantic-commits#readme"
+}

uninstall.sh

@@ -0,0 +1,15 @@
+# !/bin/bash
+echo "-------------------------------------------------"
+
+echo "╔═╗╦╔╦╗  ╔═╗╔═╗╔╦╗╔═╗╔╗╔╔╦╗╦╔═╗  ╔═╗╔═╗╔╦╗╔╦╗╦╔╦╗
+║ ╦║ ║   ╚═╗║╣ ║║║╠═╣║║║ ║ ║║    ║  ║ ║║║║║║║║ ║
+╚═╝╩ ╩   ╚═╝╚═╝╩ ╩╩ ╩╝╚╝ ╩ ╩╚═╝  ╚═╝╚═╝╩ ╩╩ ╩╩ ╩ "
+
+echo ""
+echo "Uninstall guide"
+echo ""
+echo "Follow the instructions below:"
+echo ""
+echo "Open ~/.bashrc or ~/.zshrc, search '#git-semantic-commits' and delete the two lines found"
+echo "After that, restart your terminal!"
+echo ""