Skip to content

Commit

Permalink
📚 Flesh out the readme a little
Browse files Browse the repository at this point in the history
  • Loading branch information
davep committed Nov 30, 2022
1 parent 74fb6e7 commit 89bfdf7
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,35 @@
PISpy aims to be a simple but useful [PyPi](https://pypi.org/) lookup client
for the Terminal, built with [Textual](https://textual.textualize.io/).

## Installation

PISPy is a full-screen terminal-based tool and is best installed using
[`pipx`](https://pypa.github.io/pipx/):

```sh
$ pipx install pispy-client
```

## Running

Once installed, just run `pispy` from your shell.

![PISpy lookup up Textual](./img/pispy.png)

## Naming

> Wait! What? Is this pispy or pispy-client? Why the two names?
Well... when I started hacking this together I went to check if PyPi had a
package called `pispy` and it didn't, so I steamed ahead with that. Only
when I came to add the package to PyPi did it say it wouldn't let me because
it was too similar to another package.

So... package name is `pispy-client` but the content is `pispy`.

## Work in progress

PISpy is currently a work in progress. I'm still figuring out what it should
do and how; but for now it provides a simple package lookup interface.

![PISpy lookup up Textual](./img/pispy.png)

[//]: # (README.md ends here)

0 comments on commit 89bfdf7

Please sign in to comment.