Skip to content

Commit

Permalink
chore(docs): update README with cli usage (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
wilhelmagren committed Oct 4, 2023
1 parent 24424ae commit 1961d97
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,29 @@
</div>

## 馃攷 Overview
Automatically generate new files with header docstring based on LICENSE information.
Automatically generate new files or update existing codebases with header docstrings based on LICENSE information.

## 馃摝 Installation
...
```
cargo install docstring-rs
```

## 馃殌 Example usage
...
## 馃殌 Usage
```
Usage: docstring-rs.exe [OPTIONS] --directory <DIRECTORY>
Options:
-d, --directory <DIRECTORY> Name of the directory in which to create new file or update existing files,
if it does not already exist, creates the directory
-f, --file <FILE_NAME> Name of a new file to create with docstring as header. Prepends to top of
file if the target file already exists [default: *.*]
-l, --license <LICENSE> Relative path to the LICENSE file to use as header docstring. If not specified,
expects a LICENSE file to exist in the current working directory [default: LICENSE]
-u, --update Specify whether or not to try and update all available docstrings in a directory
recursively, requires <DIRECTORY> to have been set
-h, --help Print help
-V, --version Print version
```

## 馃搵 License
All code is to be held under a general MIT license, please see [LICENSE](https://github.com/wilhelmagren/docstring-rs/blob/main/LICENSE) for specific information.

0 comments on commit 1961d97

Please sign in to comment.