diff --git a/README.md b/README.md index b56040f..dcbd044 100644 --- a/README.md +++ b/README.md @@ -33,24 +33,10 @@ dev edited: 82 words (~15%) total: 539 words ``` -## Installation - -Start by cloning the project with git. Then install it with Python's `pip`. -Example: +Example with multi-file markdown: ```bash -pip3 install /path/to/novel-stats -``` - -Or, if you'd like to install it "editable" (making development/updates -easier): - -```bash -pip3 install --editable /path/to/novel-stats -``` - -```bash - novel-stats multi_file.mdpp -pp -c -a +$ novel-stats multi_file.mdpp -pp -c -a chapter 1 Lorem: 203 (drafted) 303 (dev edited) @@ -69,6 +55,22 @@ dev edited: 385 words (~40%) total: 946 words ``` +## Installation + +Start by cloning the project with git. Then install it with Python's `pip`. +Example: + +```bash +pip3 install /path/to/novel-stats +``` + +Or, if you'd like to install it "editable" (making development/updates +easier): + +```bash +pip3 install --editable /path/to/novel-stats +``` + ## Usage novel-stats takes a single argument: The path to your novel file in markdown