Skip to content

Commit 6f0fbd6

Browse files
committed
Update README
1 parent c02725f commit 6f0fbd6

1 file changed

Lines changed: 20 additions & 30 deletions

File tree

README.md

Lines changed: 20 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
11
# HackerTray
22

3-
[![HackerTray on PyPi](https://pypip.in/v/hackertray/badge.png)](https://pypi.python.org/pypi/hackertray/)
4-
[![HackerTray on PyPi](https://pypip.in/d/hackertray/badge.png)](https://pypi.python.org/pypi/hackertray/)
5-
[![Build Status](https://travis-ci.org/captn3m0/hackertray.png)](https://travis-ci.org/captn3m0/hackertray) [![Coverage Status](https://coveralls.io/repos/github/captn3m0/hackertray/badge.svg?branch=master)](https://coveralls.io/github/captn3m0/hackertray?branch=master)
3+
[![PyPI - Version](https://img.shields.io/pypi/v/hackertray)](https://pypi.python.org/pypi/hackertray/)
4+
[![Coverage Status](https://coveralls.io/repos/github/captn3m0/hackertray/badge.svg?branch=master)](https://coveralls.io/github/captn3m0/hackertray?branch=master)
5+
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/captn3m0/hackertray/test.yml)
66

77
HackerTray is a simple [Hacker News](https://news.ycombinator.com/) Linux application
88
that lets you view top HN stories in your System Tray. It uses appindicator where available,
99
but provides a Gtk StatusIcon fallback in case AppIndicator is not available.
1010

11-
The inspiration for this came from [Hacker Bar](http://hackerbarapp.com), which is Mac-only.
11+
The inspiration for this came from [Hacker Bar](https://web.archive.org/web/20131126173924/http://hackerbarapp.com/) (now dead), which was Mac-only.
12+
13+
Over the years, this has been tested across multiple system tray implementations, including:
14+
15+
- Waybar on sway
16+
- i3bar with i3
17+
- ElementaryOS
18+
- KDE Plasma 6.6
19+
- GNOME 50
20+
21+
The new flatpak installation is in need of more testing.
1222

1323
## Screenshot
1424

@@ -19,38 +29,18 @@ The inspiration for this came from [Hacker Bar](http://hackerbarapp.com), which
1929
HackerTray is distributed as a python package. Do the following to install:
2030

2131
```sh
22-
sudo pip install hackertray
23-
OR
24-
sudo easy_install hackertray
25-
OR
26-
#Download Source and cd to it
27-
sudo python setup.py install
32+
pipx install hackertray
2833
```
2934

30-
After that, you can run `hackertray` from anywhere and it will run. You can
31-
now add it to your OS dependent session autostart method. In Ubuntu, you can
32-
access it via:
33-
34-
1. System > Preferences > Sessions
35-
(OR)
36-
2. System > Preferences > Startup Applications
37-
38-
depending on your Ubuntu Version. Or put it in `~/.config/openbox/autostart`
39-
if you are running OpenBox. [Here](http://imgur.com/mnhIzDK) is how the
40-
configuration should look like in Ubuntu and its derivatives.
35+
There is a Flatpak build and submission in progress.
4136

4237
### Upgrade
4338

44-
The latest stable version is [![the one on PyPi](https://pypip.in/v/hackertray/badge.png)](https://pypi.python.org/pypi/hackertray/)
39+
The latest stable version is 5.0.0.
4540

4641
You can check which version you have installed with `hackertray --version`.
4742

48-
To upgrade, run `pip install -U hackertray`. In some cases (Ubuntu), you might
49-
need to clear the pip cache before upgrading:
50-
51-
`sudo rm -rf /tmp/pip-build-root/hackertray`
52-
53-
HackerTray will automatically check the latest version on startup, and inform you if there is an update available.
43+
HackerTray will automatically check the latest version on startup, and inform you if there is an update available on the command line.
5444

5545
## Options
5646

@@ -100,8 +90,8 @@ Note that appindicator is no longer supported in non-Ubuntu distros, because it
10090
To develop on hackertray, or to test out experimental versions, do the following:
10191

10292
- Clone the project
103-
- Run `(sudo) python setup.py develop` in the hackertray root directory
104-
- Run `hackertray` with the required command line options from anywhere.
93+
- Run `uv venv --system-site-packages`. This is required to allow access to the global pygobject install.
94+
- Run `uv run hackertray` with the required command line options
10595

10696
## Analytics
10797

0 commit comments

Comments
 (0)