Skip to content

Commit

Permalink
update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Audiosutras committed Nov 16, 2023
1 parent b76d436 commit 0ccfd3f
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions READMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@

![CI](https://github.com/Audiosutras/getdat/actions/workflows/ci.yml/badge.svg?branch=master)

Table of Contents

- [Installation Methods](#installation-methods)
- [Commands](#commands)
- [Local Development](#local-development)
- [Contributors](#contributors)

## Installation Methods

Install using `pipx`:
Expand All @@ -31,7 +38,7 @@ Install using `pipx`:

#### [Ebook](#ebook)

## Cinema
### Cinema
Launches [movie-web.app](https://movie-web.app/search/movie) in your default browser

<div align="center">
Expand All @@ -45,7 +52,7 @@ Launches [movie-web.app](https://movie-web.app/search/movie) in your default bro
-> getdat cinema
```

## Ebook
### Ebook
Search and download an ebook available through [Anna's Archive](https://annas-archive.org/). You can think of this command as "headless" Anna's Archive

<div align="center">
Expand Down Expand Up @@ -154,6 +161,16 @@ Style guide and code check enforced with [pre-commit](https://pre-commit.com/)
(getdat-py3.11) -> pre-commit install
```
## Publishing Package
Workflow: `master` branch
1. In `pyproject.toml` *bump* the version number `*.*.*`
2. Create a [git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) with the new version number `*.*.*` you specified in `pyproject.toml`.
3. Push the newly created tag `git push origin *.*.*` to the repository. This will trigger the `pre-release.yml` github workflow to publish our package to `test.pypi`.
## Contributors
![GitHub Contributors Image](https://contrib.rocks/image?repo=Audiosutras/getdat)

0 comments on commit 0ccfd3f

Please sign in to comment.