diff --git a/README.md b/README.md index 73b2195..0d73d9c 100644 --- a/README.md +++ b/README.md @@ -6,27 +6,38 @@ A terminal based archive reader for Hyperkitty, GNU Mailman's official archiver. Screenshots ----------- -![Page Add Mailinglist](screenshots/page_subscribe_mailinglist.svg) +![Page Add Mailinglist](https://raw.githubusercontent.com/maxking/archive_reader/main/screenshots/page_subscribe_mailinglist.svg) -![Page View threads](screenshots/page_threads_list.svg) +![Page View threads](https://raw.githubusercontent.com/maxking/archive_reader/main/screenshots/page_threads_list.svg) -![Page Read Thread](screenshots/page_read_thread.svg) +![Page Read Thread](https://raw.githubusercontent.com/maxking/archive_reader/main/screenshots/page_read_thread.svg) +Using +----- -Hyperkitty Configuration ------------------------- - -In order to use this app, the Pagination on the Hyperkitty's API needs to be set correctly. +To run the app, you can install it using [Pipx](https://pypa.github.io/pipx/): +```bash +# Install using pipx. +$ pipx install areader +# Run the app: +$ areader +``` -Running -------- -To run the app, first you need to create a virtualenv and then finally install dependencies. +If you don't have Pipx, you can install directly in a venv to run: ```bash +# Setup a virtualenv to install the package. $ python3 -m venv .venv $ source .venv/bin/activate -$ pip install -e . -$ pdm run start -``` \ No newline at end of file +$ pip install areader + +# Run the app: +$ areader +``` + +Hyperkitty Configuration +------------------------ + +In order to use this app, the Pagination on the Hyperkitty's API needs to be set correctly. diff --git a/pyproject.toml b/pyproject.toml index 717e6a3..d0460db 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "areader" -version = "0.1.0" +version = "0.1.1" description = "Terminal based archives reader for Hyperkitty, GNU Mailman's archiver" authors = [ {name = "Abhilash Raj", email = "raj.abhilash1@gmail.com"},