Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Audiosutras committed Nov 13, 2023
1 parent e1c5e12 commit f6460f1
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 8 deletions.
42 changes: 35 additions & 7 deletions docs/READMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,19 +41,47 @@ Launches [movie-web.app](https://movie-web.app/search/movie) in your default bro
-> getdat cinema
```

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

<div align="center">
<img
src="/docs/static/getdat-ebook.gif"
alt="Gif of GetDat Cinema Command In Action"
alt="Gif of GetDat Cinema Command In Action"
/>
</div>

* The demo for this command downloaded an epub format of Robert Louis Stevenson's and N.C. Wyeth's book *Treasure Island*. This book is in the public domain.
* The demo for this command opens the downloaded ebook using [epr](https://github.com/wustho/epr), a terminal epub reader to show the contents of the downloaded book. You can expect higher ebook quality by using a desktop e-reader like [librum](https://librumreader.com/)
* Anna's Archive `SciDB` search is not yest supported.


```bash
-> getdat ebook <Search>
-> getdat ebook [OPTIONS] [Q]
```
* Tests are a work in progress for this command
* The demo for this command downloaded an epub format of Robert Louis Stevenson's and N.C. Wyeth's book *Treasure Island*. This book is in the public domain.
* The demo opens the downloaded epub

#### ARGUMENTS

| Name | Help |
|------|------|
| Q | Search |

Example:
```bash
-> getdat ebook "Treasure Island Stevenson"
```
or
```bash
-> getdat ebook Treasure Island Stevenson
```

#### OPTIONS

| Name | Convention 1 | Convention 2 | Type | Help |
| ---- | ------------ | ------------ | ----| ----|
| Output Directory | -o | --output_dir | Text | Path to ebook's output directory from home directory. Path must be prefixed by `~` on Unix or `~user` on Windows. This argument overrides `GETDAT_BOOK_DIR` env var if set. Outputs book to working directory if neither are set.
| Extension | -e | --ext | [epub | pdf] | Preferred ebook extension for search results


#### Notes
* Tests are a work in progress for this command
Binary file modified docs/static/getdat-cinema.gif
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 docs/static/getdat-ebook.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/getdat/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def cinema():
'--ext',
type=click.Choice(['epub', 'pdf']),
default="epub",
help="Preferred Ebook extension"
help="Preferred ebook extension for search results"
)
@click.argument('q', nargs=-1)
def ebook(q, ext, output_dir):
Expand Down

0 comments on commit f6460f1

Please sign in to comment.