README.md in urban_pass-0.2.2 vs README.md in urban_pass-0.2.3
- old
+ new
@@ -12,33 +12,44 @@
$ gem install urban_pass
## Usage
+To save hitting an extra key you can also add this alias:
+
```
-Commands:
+alias urban-pass=urban_pass
+```
+
+A list of commands:
+
+```
urban_pass # Alias for urban_pass generate_phrase
+ urban_pass define [WORD] # Defines a word you may not know
urban_pass generate_phrase # Creates a new pass-phrase
urban_pass help [COMMAND] # Describe available commands or one specific command
```
## Contribution Guidelines
-###Git Commit Messages
-- Use the present tense ("Add feature" not "Added feature")
-- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
-- Limit the first line to 72 characters or less
-- Reference issues and pull requests liberally
-- When contributing please consider starting the commit message with an applicable emoji:
+### Git Commit Messages
- - :lipstick: `:lipstick:` when improving the format/structure of the code
- - :racehorse: `:racehorse:` when improving performance
- - :memo: `:memo:` when writing docs
- - :penguin: `:penguin:` when fixing something on Linux
- - :apple: `:apple:` when fixing something on Mac OS
- - :checkered_flag: `:checkered_flag:` when fixing something on Windows
- - :bug: `:bug:` when fixing a bug
- - :fire: `:fire:` when removing code or files
- - :green_heart: `:green_heart:` when fixing the CI build
- - :white_check_mark: `:white_check_mark:` when adding tests
- - :lock: `:lock:` when dealing with security
- - :arrow_up: `:arrow_up:` when upgrading dependencies
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+* Limit the first line to 72 characters or less
+* Reference issues and pull requests liberally
+* Consider starting the commit message with an applicable emoji:
+ * :art: `:art:` when improving the format/structure of the code
+ * :racehorse: `:racehorse:` when improving performance
+ * :non-potable_water: `:non-potable_water:` when plugging memory leaks
+ * :memo: `:memo:` when writing docs
+ * :penguin: `:penguin:` when fixing something on Linux
+ * :apple: `:apple:` when fixing something on Mac OS
+ * :checkered_flag: `:checkered_flag:` when fixing something on Windows
+ * :bug: `:bug:` when fixing a bug
+ * :fire: `:fire:` when removing code or files
+ * :green_heart: `:green_heart:` when fixing the CI build
+ * :white_check_mark: `:white_check_mark:` when adding tests
+ * :lock: `:lock:` when dealing with security
+ * :arrow_up: `:arrow_up:` when upgrading dependencies
+ * :arrow_down: `:arrow_down:` when downgrading dependencies
+ * :shirt: `:shirt:` when removing linter warnings