From afddf8558597166061f6fcabf6b91d9aef69acfe Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marek=20Sieroci=C5=84ski?= <marek.sierocinski@cdq.com>
Date: Wed, 4 Dec 2024 11:51:00 +0100
Subject: [PATCH] docs: Add README

---
 .editorconfig    |  3 +++
 README.md        | 51 ++++++++++++++++++++++++++++++++++++++++++++++++
 _static/logo.svg | 51 ++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 105 insertions(+)
 create mode 100644 README.md
 create mode 100644 _static/logo.svg

diff --git a/.editorconfig b/.editorconfig
index a0df292..1558887 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -11,3 +11,6 @@ tab_width = 4
 
 [{gah,*.sh,*.bash,*.bats}]
 indent_style = tab
+
+[*.md]
+indent_size = 2
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e3b96ca
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+![gah! logo](./_static/logo.svg)
+
+`gah` is an GitHub Releases app installer, that does not require sudo. It is a simple bash script that downloads the latest release of an app from GitHub and installs it in `~/.local/bin`. It is designed to be used with apps that are distributed as a single binary file.
+
+Features:
+
+- Downloads the latest or given release of an app from GitHub
+- Automatically selects matching binary for the current platform
+
+  - Supported OS: Linux and MacOS
+  - Supported architectures: x64 and ARM64
+
+- Supports multiple matching apps in a single GitHub Release
+- Supports archived (`.zip`, `.tar.gz`, `.tar.bz2`, `.tar.xz`) and single binary releases
+- Has own base of predefined aliases for GitHub repositories (PRs are welcome!)
+
+## Installation
+
+TODO
+
+## Usage
+
+Type `gah help` to see the list of available commands.
+
+```text
+gah
+  install <github_owner/github_repo_name | known_alias> [<git_tag>]
+  show <aliases>
+  help
+  version
+```
+
+## Examples
+
+### Install latest version of gh (GitHub CLI)
+
+```bash
+gah install gh
+```
+
+### Install specific version of argocd
+
+```bash
+gah install argocd v2.0.3
+```
+
+### Install an app that is not in the predefined aliases
+
+```bash
+gah install hashicorp/vagrant
+```
diff --git a/_static/logo.svg b/_static/logo.svg
new file mode 100644
index 0000000..13241b4
--- /dev/null
+++ b/_static/logo.svg
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   width="126"
+   height="60"
+   viewBox="0 0 126 60"
+   version="1.1"
+   id="svg1"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:dc="http://purl.org/dc/elements/1.1/">
+  <title
+     id="title6">gah logo</title>
+  <defs
+     id="defs1" />
+  <g
+     id="layer1">
+    <g
+       id="text3"
+       style="font-size:74.0152px;line-height:1.25;font-family:Dyuthi;-inkscape-font-specification:'Dyuthi, Normal';letter-spacing:0px;word-spacing:0px;fill:#aba835;stroke-width:1.85038"
+       aria-label="gah!"
+       transform="translate(-40.610838,-87.602298)">
+      <path
+         style="fill:#000000"
+         d="m 64.174269,123.23657 q 0,0 0,-11.854 -0.722805,-2.09613 -3.830865,-3.28876 -3.10806,-1.19263 -6.396821,0.43368 -1.590171,0.79509 -2.529817,2.81894 -0.939646,2.02385 -0.903505,4.51753 v 3.93929 q 0,3.6863 1.987712,6.36068 2.059994,2.63823 4.878932,2.63823 1.59017,0.25299 3.288761,-0.28912 3.433322,-1.19263 3.505603,-5.27647 z m 1.770871,-21.75642 h 4.228407 q 1.770872,0 3.07192,1.30105 1.301049,1.30104 1.337189,3.10806 v 26.74377 h -0.07228 q -0.10842,7.58945 -4.842791,11.45645 -4.73437,3.90315 -11.709435,3.46946 -0.469823,-0.0361 -2.240695,-0.0361 -1.770871,0.0361 -5.999279,0 -1.987712,0 -3.1442,-1.66245 -1.156487,-1.66245 -0.505963,-3.5056 l 0.07228,-0.0361 q 0.939646,-2.63824 3.686304,-2.6021 3.758584,0.0723 8.059272,0.0723 6.469102,0 6.21612,-7.44488 -3.577883,2.09613 -7.661729,2.13227 -6.577523,0 -11.203472,-4.87893 -4.62595,-4.87893 -4.62595,-11.81786 0,-6.93892 4.62595,-11.81785 4.625949,-4.87894 11.203472,-4.87894 4.083846,0 7.73401,2.13228 0.03614,-0.68667 0.542103,-1.19263 0.505964,-0.5421 1.228768,-0.5421 z m 22.515366,15.75714 q 0,0 0,2.38525 0,3.75859 1.987713,6.39683 1.987713,2.63823 4.806651,2.56595 1.662451,0.1807 3.361042,-0.32526 3.433318,-1.19263 3.433318,-5.20419 0,0 0,-12.2154 -0.65052,-2.06 -3.758581,-3.21648 -3.10806,-1.19263 -6.469101,0.39754 -3.361042,1.55403 -3.361042,9.21576 z m -5.276474,12.46838 q -4.62595,-4.87893 -4.62595,-11.78172 0,-6.93892 4.62595,-11.81785 4.62595,-4.87893 11.203472,-4.87893 5.529456,0 7.661726,4.87893 0,-1.59017 1.19263,-2.7828 1.04807,-1.04807 2.63824,-1.04807 h 2.7828 q 1.59017,0 2.71051,1.04807 1.12035,1.19263 1.12035,2.7828 v 26.38237 q 0,0.93964 -0.65052,1.51789 -0.61439,0.57824 -1.48175,0.57824 h -4.33683 q -0.93965,0 -2.16841,-1.30105 -1.22877,-1.30105 -2.20456,-1.44561 -0.97579,-0.14456 -1.843151,0.43369 -3.577883,2.31297 -5.421035,2.31297 -6.577522,0 -11.203472,-4.87893 z m 67.690658,-11.63716 q 0,0 0.0723,11.74558 0,2.09613 -1.51789,3.57788 -1.4456,1.44561 -3.57788,1.44561 h -0.10842 q -2.09613,0 -3.57788,-1.44561 -1.44561,-1.44561 -1.44561,-3.57788 v -13.76943 q 0,-5.52945 -3.21648,-7.11962 -3.21648,-1.55403 -6.72209,0.61438 -3.54174,2.13227 -3.5056,4.84279 v 15.3596 q 0,2.16841 -1.51789,3.65016 -1.51789,1.44561 -3.65016,1.44561 h -0.0361 q -2.16842,0 -3.65017,-1.44561 -1.4456,-1.44561 -1.4456,-3.65016 V 92.698071 q 0,-2.096134 1.4456,-3.650164 1.59018,-1.445609 3.68631,-1.445609 h 0.0723 q 2.09613,0 3.65016,1.445609 1.44561,1.445609 1.44561,3.577883 l 0.10842,12.79364 q 4.04771,-3.57788 7.66173,-3.97542 8.20384,-0.86737 12.0347,4.01156 3.79472,4.87893 3.79472,12.61294 z"
+         id="path5" />
+      <path
+         style="fill:#d8d440"
+         d="m 165.18623,92.372808 q 0,0 -1.12035,21.648002 -0.14456,1.69859 -1.30105,2.81894 -1.26491,1.12034 -2.9635,1.12034 -1.69859,0 -2.99964,-1.12034 -1.19262,-1.12035 -1.30105,-2.81894 L 154.3803,92.372808 q -0.0723,-1.843151 1.19263,-3.1442 1.19262,-1.301048 3.03577,-1.337188 h 2.34912 q 1.84315,0 3.03578,1.337188 1.33719,1.301049 1.19263,3.1442 z m -1.04807,40.368642 q -1.69859,1.84315 -4.30069,1.84315 -2.56595,0 -4.40911,-1.80701 -1.84315,-1.80701 -1.84315,-4.33683 0,-2.52982 1.84315,-4.37297 1.84316,-1.87929 4.40911,-1.87929 2.56596,0 4.30069,1.84315 1.84315,1.77087 1.84315,4.37297 0,2.56596 -1.84315,4.33683 z"
+         id="path6" />
+    </g>
+  </g>
+  <metadata
+     id="metadata6">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:title>gah logo</dc:title>
+        <dc:date>04.12.2024</dc:date>
+        <dc:creator>
+          <cc:Agent>
+            <dc:title>Marek Sierociński</dc:title>
+          </cc:Agent>
+        </dc:creator>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+</svg>