Skip to content

Commit 2ecf631

Browse files
committed
update readme
1 parent 41417a6 commit 2ecf631

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,41 @@
1-
# py3status_http_monitor
2-
py3status module for monitoring http services
1+
# py3status-http-monitor
2+
Python module for monitoring **http** services in your py3status bar.
33

44
## Screenshot
5-
![Status Bar with py3status_http_monitor](/images/status_bar.png)
5+
![Status Bar with py3status_http_monitor](https://raw.githubusercontent.com/mcgillij/py3status-http-monitor/main/images/status_bar.png)
66

77
## Prerequisites
88

99
This is an i3 / py3status module, so you'll need those first off.
1010

1111
## Installation
1212

13-
```bash
14-
git clone git@github.com:mcgillij/py3status-http-monitor.git ~/.i3/py3status/
13+
### From Git
14+
15+
``` bash
16+
git clone https://github.com/mcgillij/py3status-http-monitor.git
17+
mkdir -p ~/.i3/py3status && cd ~/.i3/py3status
18+
ln -s <PATH_TO_CLONED_REPO>/src/py3status-http-monitor/http_monitor.py ./
19+
```
20+
21+
### With Pip
22+
23+
``` bash
24+
pip install py3status-http-monitor
25+
```
26+
27+
### Building Arch package w/PKGBUILD
28+
29+
``` bash
30+
git clone https://aur.archlinux.org/py3status-http-monitor.git
31+
cd py3status-http-monitor.git
32+
makechrootpkg -c -r $HOME/$CHROOT
33+
```
34+
35+
### Installing built Arch package
36+
37+
``` bash
38+
sudo pacman -U --asdeps py3status-http-monitor-*-any.pkg.tar.zst
1539
```
1640

1741
## Configuration
@@ -72,7 +96,8 @@ http_monitor 'medusa' {
7296
service_location = "http://yourserver:8081"
7397
service_name = '🐍'
7498
}
75-
```
99+
```
100+
76101
## Configuration Options
77102

78103
You can pass in the following configuration options:
@@ -81,4 +106,3 @@ You can pass in the following configuration options:
81106
* service_name
82107
* timeout
83108
* cache_timeout
84-

0 commit comments

Comments
 (0)