README.md in markdown_exec-0.2.6 vs README.md in markdown_exec-1.0.0
- old
+ new
@@ -53,10 +53,14 @@
#### `mde my.md` or `mde -f my.md`
Select a block to execute from `my.md`.
+#### `mde my.md myblock`
+
+Execute the block named `myblock` from `my.md`.
+
#### `mde .` or `mde -p .`
Select a markdown file in the current folder. Select a block to execute from that file.
### Report documents and blocks
@@ -140,12 +144,32 @@
e.g. `export MDE_SAVE_EXECUTED_SCRIPT=1`
e.g. `export MDE_SAVE_EXECUTED_SCRIPT=`
- Specify variable on command line.
e.g. `MDE_SAVE_EXECUTED_SCRIPT=1 mde`
-# Example blocks
+## Tab Completion
+### Install tab completion
+
+Append a command to load the completion script to your shell configuration file:
+
+```bash :()
+echo "source $(mde --pwd)/bin/tab_completion.sh" >> ~/.bash_profile
+```
+
+### Example Completions
+
+Type tab at end of any of the following commands to see the options.
+- `mde `
+- `mde -`
+- `mde --`
+- `mde --o`
+- `mde --filename my.md -`
+- `mde --filename my.md --`
+
+## Example Blocks
+
When prompted, select either the `awake` or `asleep` block.
``` :(day)
export TIME=early
```
@@ -162,20 +186,9 @@
export ACTIVITY=asleep
```
``` :(report)
echo "$TIME -> $ACTIVITY"
-```
-
-``` :missing_command
-fail
-```
-
-``` :exit_value
-echo "a"
-echo "b"
-echo "c" >>/dev/stderr
-grep nx Gemfile
```
# License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).