Add GIF of Scribe-Data usage to readme

[andrewtavis]

Terms

• [X] I have searched open and closed feature requests
• [X] I agree to follow Scribe-Data's Code of Conduct

Description

This issue would add a GIF of how users can use the Scribe-Data CLI to the project's readme. From a dev sync, what should be included is:

• Total + query what was shown for total
• scribe-data list --languages
• scribe-data list --data-type
• scribe-data total -lang German -dt nouns -> "There are XYZ German nouns on Wikidata"
• scribe-data query -lang German -dt nouns -> Query of German nouns and saving the output locally
• scribe-data interactive -> Show workflow for something not yet focussed on

Contribution

Would be happy to work on this once we're a bit further along in GSoC or review a PR! 😊

[andrewtavis]

Blocking this for now until we have a few more issues done :)

CC @mhmohona, @axif0, @wkyoshida

[andrewtavis]

@axif0, do you want to be assigned here seeing as how you've already made some usage videos? We'd want this to wait just a bit so we're recording the more final version of the CLI, but would be great to get your support here :)

[axif0]

Ya definitely.

[andrewtavis]

Nice ok :) Still leaving this as blocked, but let's get to it in say mid November when things settle a bit more. Will be really important for when we let the Wikidata community know this is done 😊

[andrewtavis]

Unblocked, @axif0! Let us know what you think you'd like to include in this before making it :)

I'll send a message to the data channel now to ask for testing of the new formatting changes, but this can proceed while that happens 😊

CC @mhmohona 👋

[axif0]

I'm using terminal-profile. Do you have any color preferences in mind? Or any other terminal window should I use?

Demo-

Also, Are we going to show the cli works in a single GIF?

Also, for total, we can get scribe-data total --language Q1860 -dt verbs. Should we put that too, in the GIF?

[andrewtavis]

I'd say a dark mode terminal should be fine, and maybe one GIF for list, total and get, and another GIF for interactive mode? Maybe also let's just use language names instead of QIDs as the point is that the user doesn't need to know them.

[axif0]

Is this ok? Total 36 second.

List,Total and Get:

interactive:

[andrewtavis]

These are looking good, @axif0! Do you want to add them in to the readme and the docs? We can add a quick code block under them that has the commands as they're a bit quick, but if we have the commands that are used in a code block under them, then it should be understandable :)

[andrewtavis]

Closed by #516 😊 So happy to have these finally, @axif0! Really appreciate the care you put into them :)