Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GIF add in Readme.md and clean code #516

Merged
merged 5 commits into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading