Browse Source

Update README.md

Adam Rutkowski 4 years ago
parent
commit
f8bc1690ae
1 changed files with 17 additions and 0 deletions
  1. 17 0
      README.md

+ 17 - 0
README.md

@@ -2,3 +2,20 @@ bumperl
 =======
 
 Semantic version bumper for Erlang/OTP apps
+
+Installation & usage
+====================
+
+```
+$ make
+$ bumperl
+Argument 'app_file' is required.
+Usage: bumperl [-a <app_file>] [-l <label>] [-c [<commit>]] [-t [<tag>]]
+
+  -a, --app     .app or .app.src file
+  -l, --label   major | minor | patch
+  -c, --commit  Automatic git commit [default: false]
+  -t, --tag     Automatic git tag (implies commit) [default: false]
+
+$ bumper -a src/bumperl.app.src -t -c -l minor
+```