Add project info options for crystal docs (#398)

crystal-lang · Apr 15, 2020 · b80fc84 · b80fc84
1 parent 1f50f86
commit b80fc84
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/using_the_compiler/README.md b/using_the_compiler/README.md
@@ -254,6 +254,8 @@ crystal docs src/my_app.cr
 
 **Common options:**
 
+* `--project-name=NAME`: Set the project name. The default value is extracted from `shard.yml` if available. In case no default can be found, this option is mandatory.
+* `--project-version=VERSION`: Set the project version. The default value is extracted from current git commit or `shard.yml` if available. In case no default can be found, this option is mandatory.
 * `--output=DIR, -o DIR`: Set the output directory (default: `./docs`)
 * `--canonical-base-url=URL, -b URL`: Set the [canonical base url](https://en.wikipedia.org/wiki/Canonical_link_element)