Skip to content

[IMP] Readme #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
OpenCode merged 1 commit into from
Nov 19, 2024
Merged

[IMP] Readme #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
# LUGUS: Your terminal feeds reader

[![PyPI - Version](https://img.shields.io/pypi/v/lugus.svg)](https://pypi.org/project/lugus)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lugus.svg)](https://pypi.org/project/lugus)
[![PyPI - Version](https://img.shields.io/pypi/v/lugus.svg?style=for-the-badge)](https://pypi.org/project/lugus)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lugus.svg?style=for-the-badge)](https://pypi.org/project/lugus)
![PyPI - Downloads](https://img.shields.io/pypi/dm/lugus?style=for-the-badge)


![readme header](https://raw.githubusercontent.com/OpenCode/lugus/main/readme/header.png)

-----

## Table of Contents

- [Installation](#installation)
- [Roadmap](#roadmap)
- [License](#license)

## Installation

/!\ **Lugus currently runs only on GNU/Linux**

```console
pip install lugus
pipx install lugus
```

## Screenshot
Expand All @@ -25,8 +23,13 @@ pip install lugus

![main page screenshot](https://raw.githubusercontent.com/OpenCode/lugus/main/readme/home.png)

### New Feed Screen

![new feed page screenshot](https://raw.githubusercontent.com/OpenCode/lugus/main/readme/new_feed.png)

## Roadmap

- [ ] Feeds management (edit, delete, ...)
- [ ] Import existing OPML files
- [ ] Export feeds as OPML file
- [ ] Set article as unread
Expand All @@ -37,7 +40,9 @@ pip install lugus
- [ ] Feeds auto-sync
- [ ] Edit existing feeds
- [ ] Search articles by name/content
- [ ] Support for Windows

## License

`LUGUS` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

Binary file added readme/new_feed.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.