Skip to content

Commit

Permalink
Merge pull request #516 from axif0/readmeGIF&codeclean
Browse files Browse the repository at this point in the history
GIF add in Readme.md and clean code
  • Loading branch information
andrewtavis authored Nov 26, 2024
2 parents ee82994 + 6ba4ef8 commit 7937f15
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 22 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<p align="center">
<img src="https://github.com/user-attachments/assets/653941a7-68bb-4d72-a0f1-3e29c75c5a16" alt="List, Total and Get GIF" width="500" height="300">
</p>

```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
```

<p align="center">
<img src="https://github.com/user-attachments/assets/4cbb85ed-d853-4008-8db9-b77ffcbe2e84" alt="Interactive GIF" width="500" height="300">
</p>

```bash
# Commands used in the above GIF:
scribe-data get -i
scribe-data total -i
```

<a id="contributing"></a>

# Contributing [``](#contents)
Expand Down
24 changes: 2 additions & 22 deletions docs/source/scribe_data/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
~~~~~~~~~~~

Expand Down

0 comments on commit 7937f15

Please sign in to comment.