diff --git a/README.md b/README.md index 2d0100d..3dde0ef 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ SummarizeMD is a simple Ruby script that generate summary (TOC) for an existing MD document. Each item of summary is linked to the respective section. -#Usage +## Usage - download file - open console - chmod +x summarizeMD @@ -10,28 +10,32 @@ Each item of summary is linked to the respective section. -#Output +## Output In order to preserve original file, the output of the script produce another file prepending generated summary. - - $ls - . - .. - summarizeMD - readme.md - +```bash +$ ls + . + .. + summarizeMD + readme.md +```
- ./summarizeMD readme.md - $ls - . - .. - summarizeMD - readme.md - summarized_readme.md - +```bash +$ ./summarizeMD readme.md +``` + +```bash +$ ls + . + .. + summarizeMD + readme.md + summarized_readme.md +``` -#Options +## Options You can launch script with some options (work in progress). @@ -47,7 +51,7 @@ Display list of available options. Display script version. -#License +## License Copyright (c) 2015 velthune