Skip to content

Commit

Permalink
doc: update README with badges and instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jb3 committed Apr 4, 2024
1 parent cf14fc9 commit f4ad75c
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Antur

![PyPI - Version](https://img.shields.io/pypi/v/antur?style=for-the-badge)
![PyPI - License](https://img.shields.io/pypi/l/antur?style=for-the-badge)
![GitHub Repo stars](https://img.shields.io/github/stars/jb3/antur?style=for-the-badge)

Antur is a Python TUI tool for browsing and debugging sitemap data.

> [!NOTE]
Expand All @@ -12,15 +16,13 @@ Antur is a Python TUI tool for browsing and debugging sitemap data.
## Installation

```bash
$ git clone [email protected]:jb3/antur.git
$ cd antur
$ poetry install
$ pip install antur
```

## Usage

```bash
$ poetry run antur
$ antur
```

## License
Expand Down

0 comments on commit f4ad75c

Please sign in to comment.