README.md in command-line-favs-0.0.1 vs README.md in command-line-favs-0.1.0
- old
+ new
@@ -2,11 +2,21 @@
Command Line Favs is a CLI utility for organizing your commonly used shell commands. Commands are stored as a **Command Name** (think Alias) to **Command** map within your ~/.favs file and can be organized into groups.
A *~/.favs* file might look something like:
+# Installation
+
+Command Line Favs is packaged a ruby gem. To install run:
+
```
+gem install command-line-favs
+```
+
+# Documentation
+
+```
#comments are supported so are un-grouped commands like this one
#positional-based substitution is also suported
pr = "echo $0"
#a group for all your ssh commands
@@ -75,17 +85,17 @@
## List Avaliable Favs
List favs within a group:
```
-fav -ls -g ssh
+fav -l -g ssh
```
List all commands:
```
-fav -ls -g
+fav -l -g
```
## Run a Fav
To run a *non-grouped* command:
@@ -104,5 +114,10 @@
```
$ fav -g TestGroup --no_prompt
```
When running an entire group of commands the default behavior is to prompt on each command. This can be overridden by supplying the *--no_prompt* flag.
+
+## Future enhancements
+
+* Tab completion for groups and commands
+* Support the running of bash/zsh built-in commmands