Merge pull request #7 from mesaugat/patch-1

Cleanup README.md

Author: sbimochan

README.md

@@ -1,26 +1,35 @@
-## Smart commit
-Create commit with current branch name
+# Smart Commit
 
-For example:
-If your current branch name is ```EF-803```
+Create a commit prefixed with the current branch name.
 
-```commit "New feature"```
+## Installation
 
-will produce command
+Run this command on terminal.
 
- ```git commit -m "EF-803: New feature"``` and execute it
+```shell
+curl https://raw.githubusercontent.com/sbimochan/smart-commit/master/commit -o /usr/local/bin/commit && chmod +x /usr/local/bin/commit
+```
 
-If your current branch is ```dev or uat or qa or master```
+## Usage
 
-```commit "New feature"```
+* If your current branch name is `EF-803`
 
-will produce default command
+```shell
+$ commit "New feature"
 
- ```git commit -m "New feature"``` and execute it
+# translates to
+git commit -m "EF-803: New feature"
+```
 
-### Installation
-Run this command on terminal
+* If your current branch is either of `dev`, `uat`, `qa`, `staging` or `master`
 
-```curl https://raw.githubusercontent.com/sbimochan/smart-commit/master/commit -o /usr/local/bin/commit && chmod +x /usr/local/bin/commit```
+```shell
+$ commit "New feature"
 
-And restart the terminal
+# translates to
+git commit -m "New feature"
+```
+
+## License
+
+[MIT](LICENSE)

commit

@@ -1,5 +1,7 @@
 #!/usr/bin/env bash
+
 echo 'Running commit script'
+
 CURRENT_BRANCH_CMD="git rev-parse --abbrev-ref HEAD"
 CURRENT_BRANCH=$(eval $CURRENT_BRANCH_CMD)
 
@@ -8,7 +10,7 @@ DEFAULT_COMMIT="git commit -m \"$1\""
 
 if [ "$CURRENT_BRANCH" != "dev" ] && [ "$CURRENT_BRANCH" != "master" ] && [ "$CURRENT_BRANCH" != "qa" ] && [ "$CURRENT_BRANCH" != "uat" ] && [ "$CURRENT_BRANCH" != "staging" ]
 then
-    echo "Commiting with branch name-> $CURRENT_BRANCH"
+    echo "Commiting with branch name -> $CURRENT_BRANCH"
     eval $COMMIT_WITH_BRANCH
 else
     echo "Commiting with default branch"