Skip to content

Commit

Permalink
📚 Revamp the README
Browse files Browse the repository at this point in the history
  • Loading branch information
davep committed Apr 17, 2024
1 parent eeb9560 commit f20a6be
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 17 deletions.
22 changes: 5 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Introduction

PISpy aims to be a simple but useful [PyPi](https://pypi.org/) lookup client
for the Terminal, built with [Textual](https://textual.textualize.io/).
PISpy aims to be a simple but useful [PyPI](https://pypi.org/) lookup client
for the terminal.

## Installation

Expand All @@ -29,22 +29,10 @@ $ brew install pispy

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

![PISpy lookup up Textual](https://raw.githubusercontent.com/davep/pispy/main/img/pispy.png)
![PISpy lookup up Tinboard](https://raw.githubusercontent.com/davep/pispy/main/img/pispy.png)

## Naming
![PISpy lookup up Tinboard](https://raw.githubusercontent.com/davep/pispy/main/img/pispy-description.png)

> 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 Tinboard](https://raw.githubusercontent.com/davep/pispy/main/img/pispy-wheel.png)

[//]: # (README.md ends here)
Binary file added img/pispy-description.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/pispy-wheel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified img/pispy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f20a6be

Please sign in to comment.