Cleanup

Author: mesaugat

README.md

@@ -1,26 +1,33 @@
-## 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 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`
+
+```shell
+$ commit "New feature"
+```
 
-will produce default command
+will translate to
 
- ```git commit -m "New feature"``` and execute it
+ ```shell
+ $ 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`
+
+```commit "New feature"```
 
-```curl https://raw.githubusercontent.com/sbimochan/smart-commit/master/commit -o /usr/local/bin/commit && chmod +x /usr/local/bin/commit```
+will execute without prefixing the branch name.
 
-And restart the terminal
+ `git commit -m "New feature"`