Merge pull request #348 from citation-file-format/readme-usage-text

Readme usage text
citation-file-format · Jul 24, 2023 · 84154f6 · 84154f6
2 parents 9770d1b + 3f79d26
commit 84154f6
Showing 1 changed file with 14 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -16,14 +16,14 @@ Command line program to validate and convert [`CITATION.cff`](https://github.com
 
 ## Supported input versions of the Citation File Format
 
-| Citation File Format schema version | Link to Zenodo release |
-| --- | --- |
-| `1.3.0` | unreleased |
-| `1.2.0` | [![Zenodo DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5171937.svg)](https://doi.org/10.5281/zenodo.5171937) |
-| `1.1.0` | [![Zenodo DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4813122.svg)](https://doi.org/10.5281/zenodo.4813122) |
-| `1.0.3` | [![Zenodo DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1222163.svg)](https://doi.org/10.5281/zenodo.1222163) |
-| `1.0.2` | [![Zenodo DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1120256.svg)](https://doi.org/10.5281/zenodo.1120256) |
-| `1.0.1` | [![Zenodo DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1117789.svg)](https://doi.org/10.5281/zenodo.1117789) |
+| Citation File Format schema version | Link to Zenodo release                                                                                           |
+|-------------------------------------|------------------------------------------------------------------------------------------------------------------|
+| `1.3.0`                             | unreleased                                                                                                       |
+| `1.2.0`                             | [![Zenodo DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5171937.svg)](https://doi.org/10.5281/zenodo.5171937) |
+| `1.1.0`                             | [![Zenodo DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4813122.svg)](https://doi.org/10.5281/zenodo.4813122) |
+| `1.0.3`                             | [![Zenodo DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1222163.svg)](https://doi.org/10.5281/zenodo.1222163) |
+| `1.0.2`                             | [![Zenodo DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1120256.svg)](https://doi.org/10.5281/zenodo.1120256) |
+| `1.0.1`                             | [![Zenodo DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1117789.svg)](https://doi.org/10.5281/zenodo.1117789) |
 
 ## Supported output formats
 
@@ -92,6 +92,8 @@ Shows:
 ```shell
 Usage: cffconvert [OPTIONS]
 
+  Command line program to validate and convert CITATION.cff files.
+
 Options:
   -i, --infile PATH               Path to the CITATION.cff input file. If this
                                   option is omitted, './CITATION.cff' is used.
@@ -103,6 +105,10 @@ Options:
   --show-trace                    Show error trace.
   --validate                      Validate the CITATION.cff file and exit.
   --version                       Print version and exit.
+  --verbose                       Control output verbosity.
+
+  If this program is useful to you, consider giving it a star on GitHub:
+  https://github.com/citation-file-format/cffconvert
 ```
 
 ## Example usage