From 89bfdf7ecee2657b3e09a4b9ff9726a98dd4ed18 Mon Sep 17 00:00:00 2001 From: Dave Pearson Date: Wed, 30 Nov 2022 15:34:25 +0000 Subject: [PATCH] :books: Flesh out the readme a little --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5543698..442ef2f 100644 --- a/README.md +++ b/README.md @@ -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)