Skip to content

Commit

Permalink
docs: update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
rorycl committed May 1, 2024
1 parent 77a28a2 commit 43a15da
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 9 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@

A Go module with console, cli and web app clients for rapid and
effective searches for equipment on Cex/Webuy using the unofficial
`webuy.io` json search endpoint. Note that these programs only work for
queries made in the UK (or via a proxy terminating in the UK).
`webuy.io` json search endpoint.

Note that these programs only work for queries made in the UK (or via a
proxy terminating in the UK).

This is intended to be a fun project and is not intended for commercial
use.

## Usage

Expand All @@ -22,8 +27,8 @@ A [bubbletea](https://github.com/charmbracelet/bubbletea) console app.

<img width="1000" src="cmd/console/console.gif" />

Have a look at the [README](cmd/console/README.md) for the console app
for more info about the architecture of this client.
Have a look at the app [README](cmd/console/README.md) for more info
about the architecture of this client.

**cli**

Expand All @@ -44,6 +49,9 @@ the switches.)

<img width="1000" src="cmd/web/web.gif" />

Note that since this gif was made the delimiter character between search
terms has changed from `,` to `;`.


## Licence

Expand Down
4 changes: 2 additions & 2 deletions cmd/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ A cli client to `cexfind`.

<img width="1000" src="./cli.gif" />

The animated gif was made with the Charm
[vhs](https://github.com/charmbracelet/vhs) app.
The animated gif was made with Charm's
[vhs](https://github.com/charmbracelet/vhs).
7 changes: 5 additions & 2 deletions cmd/console/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# cexfind console app

This console app is written using the
This console app, which uses the
[cexfind](https://github.com/rorycl/cexfind/) go module to make searches
on Cex/Webuy, is written using the
[bubbletea](https://github.com/charmbracelet/bubbletea) TUI framework.

## Running the programme
Expand All @@ -11,7 +13,8 @@ that the app only works for queries emanating from the UK.

![](console.gif)

This gif was made using [vhs](https://github.com/charmbracelet/vhs):
This gif was made using Charm's
[vhs](https://github.com/charmbracelet/vhs):

```
vhs console.vhs
Expand Down
3 changes: 2 additions & 1 deletion cmd/web/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# webserver

A webserver client to `cexfind`.
A webserver client to `cexfind`. Note that since making this gif the
delimiter character between searches has been changed from "," to ";".

<img width="1000" src="./web.gif" />

Expand Down

0 comments on commit 43a15da

Please sign in to comment.