Skip to content

Commit 6e5de9c

Browse files
authored
Merge pull request #6 from OpenCode/fix/readme
[IMP] Readme
2 parents 8e9d172 + 1710ab5 commit 6e5de9c

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
# LUGUS: Your terminal feeds reader
22

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

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

810
-----
911

10-
## Table of Contents
11-
12-
- [Installation](#installation)
13-
- [Roadmap](#roadmap)
14-
- [License](#license)
15-
1612
## Installation
1713

14+
/!\ **Lugus currently runs only on GNU/Linux**
15+
1816
```console
19-
pip install lugus
17+
pipx install lugus
2018
```
2119

2220
## Screenshot
@@ -25,8 +23,13 @@ pip install lugus
2523

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

26+
### New Feed Screen
27+
28+
![new feed page screenshot](https://raw.githubusercontent.com/OpenCode/lugus/main/readme/new_feed.png)
29+
2830
## Roadmap
2931

32+
- [ ] Feeds management (edit, delete, ...)
3033
- [ ] Import existing OPML files
3134
- [ ] Export feeds as OPML file
3235
- [ ] Set article as unread
@@ -37,7 +40,9 @@ pip install lugus
3740
- [ ] Feeds auto-sync
3841
- [ ] Edit existing feeds
3942
- [ ] Search articles by name/content
43+
- [ ] Support for Windows
4044

4145
## License
4246

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

readme/new_feed.png

14.5 KB
Loading

0 commit comments

Comments
 (0)