docs(readme): add info about AUR availability

aravinda0 · Jul 10, 2024 · d397832 · d397832
1 parent 833e0d8
commit d397832
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -49,7 +49,9 @@ https://github.com/aravinda0/qtile-bonsai/assets/960763/b74e559a-30c0-4de7-86f4-
 
 Assuming you already have
 [qtile up and running](https://docs.qtile.org/en/latest/manual/install/), you
-can install qtile-bonsai from PyPI.
+have the following options for installation.
+
+#### PyPI
 
 ```bash
 pip install qtile-bonsai 
@@ -75,6 +77,14 @@ pip install qtile-bonsai
 > pipx inject qtile qtile-bonsai
 > ```
 
+#### AUR
+
+For arch-based distros, you can install it from the AUR either manually or with
+your favorite AUR-helper. For example:
+
+```
+yay -S qtile-bonsai
+```
 
 ### Configuration
 

diff --git a/newsfragments/aur.misc b/newsfragments/aur.misc
@@ -0,0 +1 @@
+You can now install the package from the AUR with your favorite AUR-helper. For example: `yay -S qtile-bonsai`
diff --git a/templates/README.template.md b/templates/README.template.md
@@ -49,7 +49,9 @@ https://github.com/aravinda0/qtile-bonsai/assets/960763/b74e559a-30c0-4de7-86f4-
 
 Assuming you already have
 [qtile up and running](https://docs.qtile.org/en/latest/manual/install/), you
-can install qtile-bonsai from PyPI.
+have the following options for installation.
+
+#### PyPI
 
 ```bash
 pip install qtile-bonsai 
@@ -75,6 +77,14 @@ pip install qtile-bonsai
 > pipx inject qtile qtile-bonsai
 > ```
 
+#### AUR
+
+For arch-based distros, you can install it from the AUR either manually or with
+your favorite AUR-helper. For example:
+
+```
+yay -S qtile-bonsai
+```
 
 ### Configuration
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		You can now install the package from the AUR with your favorite AUR-helper. For example: `yay -S qtile-bonsai`