aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 37 insertions, 6 deletions
diff --git a/README.md b/README.md
index 3b37c0b..3a510fa 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,35 @@
pacman-offline
==============
+[![GitHub stars](https://img.shields.io/github/stars/eworm-de/pacman-offline?logo=GitHub&style=flat&color=red)](https://github.com/eworm-de/pacman-offline/stargazers)
+[![GitHub forks](https://img.shields.io/github/forks/eworm-de/pacman-offline?logo=GitHub&style=flat&color=green)](https://github.com/eworm-de/pacman-offline/network)
+[![GitHub watchers](https://img.shields.io/github/watchers/eworm-de/pacman-offline?logo=GitHub&style=flat&color=blue)](https://github.com/eworm-de/pacman-offline/watchers)
+
**Run offline system update with pacman.**
The offline system update with pacman is achieved by integrating into
-[offline updates in systemd](https://www.freedesktop.org/software/systemd/man/systemd.offline-updates.html).
+[offline updates in systemd ↗️](https://www.freedesktop.org/software/systemd/man/systemd.offline-updates.html).
In fact only two scripts and a number of systemd unit files are used to
glue `systemd` and `pacman`.
+*Use at your own risk*, pay attention to
+[license and warranty](#license-and-warranty), and
+[disclaimer on external links](#disclaimer-on-external-links)!
+
Requirements
------------
There are the runtime dependencies:
-* [pacman](https://archlinux.org/pacman/)
-* [systemd](https://www.github.com/systemd/systemd)
+* [pacman ↗️](https://archlinux.org/pacman/)
+* [systemd ↗️](https://www.github.com/systemd/systemd)
And there's an optional dependency to support elevating privileges:
-* [polkit](https://github.com/polkit-org/polkit)
+* [polkit ↗️](https://github.com/polkit-org/polkit)
Optional basic support for
-[plymouth](https://www.freedesktop.org/wiki/Software/Plymouth/) is
+[plymouth ↗️](https://www.freedesktop.org/wiki/Software/Plymouth/) is
integrated.
Usage
@@ -67,10 +75,15 @@ You can enable a timer for nightly reboot:
This will trigger at night, if updates are pending and prepared.
+### Desktop environment
+
+A *desktop file* is installed to allow preparing from a desktop
+environment. Have a look at your application menu...
+
Configuration
-------------
-Two sinppets for inclusion in `/etc/pacman.conf` are shipped. To make use of
+Two snippets for inclusion in `/etc/pacman.conf` are shipped. To make use of
them add these line:
Include = /etc/pacman.d/offline.conf
@@ -99,6 +112,21 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
[GNU General Public License](COPYING.md) for more details.
+Disclaimer on external links
+----------------------------
+
+Our website contains links to the websites of third parties ("external
+links"). As the content of these websites is not under our control, we
+cannot assume any liability for such external content. In all cases, the
+provider of information of the linked websites is liable for the content
+and accuracy of the information provided. At the point in time when the
+links were placed, no infringements of the law were recognisable to us.
+As soon as an infringement of the law becomes known to us, we will
+immediately remove the link in question.
+
+> 💡️ **Hint**: All external links are marked with an arrow pointing
+> diagonally in an up-right (or north-east) direction (↗️).
+
### Upstream
URL:
@@ -107,3 +135,6 @@ URL:
Mirror:
[eworm.de](https://git.eworm.de/cgit.cgi/pacman-offline/)
[GitLab.com](https://gitlab.com/eworm-de/pacman-offline#pacman-offline)
+
+---
+[⬆️ Go back to top](#top)