[doc] Create the readme file

README.md

@@ -0,0 +1,30 @@
+# archy-slstatus
+## The status bar for archy-slstatus
+![simple screenshot](./screenshots/1.0.0.png)
+
+### Installation
+You can install archy-slstatus from the AUR with your favorite AUR helper.
+```sh
+yay -S archy-slstatus
+```
+Or you can install the latest version from the git repository.
+```sh
+yay -S archy-slstatus-git
+```
+Or you can build it yourself.
+```sh
+git clone https://github.com/archy-linux/archy-slstatus.git
+cd archy-slstatus
+sudo make install clean
+```
+
+### Mirrors
+* [GitHub](https://github.com/archy-linux/archy-slstatus) - The upstream repository
+* [GitLab](https://gitlab.com/archy-linux/archy-slstatus) - [![Mirror the repo to gitlab](https://github.com/archy-linux/archy-slstatus/actions/workflows/gitlab-mirror.yml/badge.svg)](https://github.com/archy-linux/archy-slstatus/actions/workflows/gitlab-mirror.yml)
+* [NotABug](https://notabug.org/archy-linux/archy-slstatus) - Not instant updates
+* [Codeberg](https://codeberg.org/archy-linux/archy-slstatus) - [![Mirror the repo to codeberg](https://github.com/archy-linux/archy-slstatus/actions/workflows/codeberg-mirror.yml/badge.svg)](https://github.com/archy-linux/archy-slstatus/actions/workflows/codeberg-mirror.yml)
+* [Gitea](https://gitea.com/archy-linux/archy-slstatus) - [![Mirror the repo to Gitea](https://github.com/archy-linux/archy-slstatus/actions/workflows/gitea-mirror.yml/badge.svg)](https://github.com/archy-linux/archy-slstatus/actions/workflows/gitea-mirror.yml)
+* [Gitdab](https://gitdab.com/archy-linux/archy-slstatus) - [![Mirror the repo to Gitdab](https://github.com/archy-linux/archy-slstatus/actions/workflows/gitdab-mirror.yml/badge.svg)](https://github.com/archy-linux/archy-slstatus/actions/workflows/gitdab-mirror.yml)
+* [Pagure](https://pagure.io/archy-slstatus) - [![Mirror the repo to pagure](https://github.com/archy-linux/archy-slstatus/actions/workflows/pagure-mirror.yml/badge.svg)](https://github.com/archy-linux/archy-slstatus/actions/workflows/pagure-mirror.yml)
+* [Bitbucket](https://bitbucket.org/archy-linux/archy-slstatus) - [![Mirror the repo to bitbucket](https://github.com/archy-linux/archy-slstatus/actions/workflows/bitbucket-mirror.yml/badge.svg)](https://github.com/archy-linux/archy-slstatus/actions/workflows/bitbucket-mirror.yml)
+* [disroot](https://git.disroot.org/archy-linux/archy-slstatus) - [![Mirror the repo to disroot](https://github.com/archy-linux/archy-slstatus/actions/workflows/disroot-mirror.yml/badge.svg)](https://github.com/archy-linux/archy-slstatus/actions/workflows/disroot-mirror.yml)