aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md26
1 files changed, 17 insertions, 9 deletions
diff --git a/README.md b/README.md
index 951e5d8..42672bb 100644
--- a/README.md
+++ b/README.md
@@ -3,28 +3,36 @@ linux-status
[![Test](https://github.com/egor-tensin/linux-status/actions/workflows/test.yml/badge.svg)](https://github.com/egor-tensin/linux-status/actions/workflows/test.yml)
-Simple Linux status web pages.
+Simple Linux status web page.
-Shows your `top`, systemd units & timers, allows you to reboot, etc.
+Shows your `top`, systemd units & timers, allows you to reboot the server, etc.
-What it looks like
-------------------
+---
![Example page][example]
[example]: img/example.png "Example page"
+---
+
+Installation
+------------
+
+* For Arch Linux, use the [AUR package].
+* For Ubuntu, use the [PPA].
+
+[AUR package]: https://aur.archlinux.org/packages/linux-status/
+[PPA]: https://launchpad.net/~egor-tensin/+archive/ubuntu/linux-status
+
+Control the app using the `linux-status` systemd unit.
+
Usage
-----
-To start a web server on port 18101:
+To manually start a web server on port 18101, run:
> python3 server.py
-There's also a [systemd unit] that you can adjust to run the server.
-
-[systemd unit]: dist/systemd/linux-status.service
-
TODO
----