From e13f8267f56fcd56cd3dadd4a5f6f0465cf93845 Mon Sep 17 00:00:00 2001
From: Beta Pictoris <git@mrhallway.me>
Date: Fri, 8 Apr 2022 23:36:39 -0700
Subject: [PATCH] :memo: Added readme

---
 docs/readme.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 docs/readme.md

diff --git a/docs/readme.md b/docs/readme.md
new file mode 100644
index 0000000..8d8f3db
--- /dev/null
+++ b/docs/readme.md
@@ -0,0 +1,23 @@
+# Wiki CLI 
+View Wikipedia articles through the CLI
+
+## Installation
+### From release
+```bash
+curl -LO https://github.com/BetaPictoris/wiki/releases/latest/download/wcli    # Download the latest binary.
+sudo install -Dt /usr/local/bin -m 755 wiki                                    # Install Wiki CLI to "/usr/local/bin" with the mode "755"
+```
+
+### Build from source 
+```bash
+git clone git@github.com:BetaPictoris/wcli.git      # Clone the repository
+cd wiki                                             # Change into the repository's directory
+bash build.sh                                       # Build Wiki CLI
+sudo install -Dt /usr/local/bin -m 755 wiki         # Install Wiki CLI to "/usr/local/bin" with the mode "755"
+```
+
+### User install
+If you don't have access to `sudo` on your system you can install to your user's `~/.local/bin` directory with this command: 
+```bash
+install -Dt ~/.local/bin -m 755 wiki
+```