diff --git a/README.md b/README.md index 549b3497..df31b96e 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,30 @@ scribe-data [command] [options] - `total` (`t`): Display the total available data for given languages and data types. - `convert` (`c`): Transform data returned by Scribe-Data into different file formats. +### Command Examples + +
+ +
+ +```bash +# Commands used in the above GIF:: +scribe-data list --language +scribe-data list --data-type +scribe-data get -l English --data-type verbs -od ./scribe-data +scribe-data total --language English +``` + ++ +
+ +```bash +# Commands used in the above GIF: +scribe-data get -i +scribe-data total -i +``` + # Contributing [`⇧`](#contents) diff --git a/docs/source/scribe_data/cli.rst b/docs/source/scribe_data/cli.rst index dffcae1a..cb554f61 100644 --- a/docs/source/scribe_data/cli.rst +++ b/docs/source/scribe_data/cli.rst @@ -51,6 +51,8 @@ Options: Example output: +The scribe-data list command (also accessible via ``scribe-data list -a``) displays both the available languages and data types. + .. code-block:: text $ scribe-data list @@ -101,28 +103,6 @@ Example output: proper-nouns verbs - -.. code-block:: text - - $scribe-data list -a - - Language ISO QID - ========================== - English en Q1860 - ... - - Available data types: All languages - =================================== - adjectives - adverbs - emoji-keywords - nouns - personal-pronouns - postpositions - prepositions - proper-nouns - verbs - Get Command ~~~~~~~~~~~