Skip to content

Commit

Permalink
Add Improved Demo Using VHS GIF (#19)
Browse files Browse the repository at this point in the history
* add demo gif and tape file

* add demo gif and tape file
  • Loading branch information
JFryy authored Jul 31, 2024
1 parent f3d03dc commit a871a13
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
`qq` is a interoperable configuration format transcoder with `jq` query syntax powered by `gojq`. `qq` is multi modal, and can be used as a replacement for `jq` or be interacted with via a repl with autocomplete and realtime rendering preview for building queries.

## Usage
Basic usage:
<a href="https://asciinema.org/a/665317" target="_blank"><img src="https://asciinema.org/a/665317.svg" /></a>
Here's some example usage, this emphasizes the interactive mode for demonstrantion, but `qq` is designed for usage in shell scripts.
![Demo GIF](docs/demo.gif)



Expand All @@ -21,7 +21,6 @@ qq file.xml -o gron | grep -vE "sweet.potatoes" | qq -i gron
# get some content from a site with html input
curl motherfuckingwebsite.com | bin/qq -i html '.html.body.ul.li[0]'


# interactive query builder mode on target file
qq . file.json --interactive
```
Expand Down
Binary file added docs/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions docs/qq.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
Output demo.gif
Set TypingSpeed 0.125
Set FontSize 30

Type@10ms "# qq is a jack of all configuration formats and a master of none. But it's still pretty good. And has a lot unique features."
Sleep 1
Enter
Type@10ms "# let's start with a simple example."
Sleep 1
Enter
Type 'clear'
Enter
Sleep .25
Type 'curl -Ls https://lobste.rs | qq -i html -I'
Enter
Sleep 1
Type 'html.body.div.ol.li[].a."@href" | split("/")[3]'
Sleep 1
Enter
Sleep 1
Type@10ms "# Let's perform a demo with a Terraform module."
Enter
Type "qq '.module' tests/test.tf -I"
Enter
Sleep 1
Tab
Sleep .5
Tab
Sleep 1
Enter
Enter
Type@10ms "# You can also output the results between included formats."
Enter
Sleep 1
Type "qq '.module' tests/test.tf -o toml"
Enter
Sleep 1.5

0 comments on commit a871a13

Please sign in to comment.