From b1b3b18b7aafc3f763e825cf20a48ecfecb14291 Mon Sep 17 00:00:00 2001
From: MedzikUser <nivua1fn@duck.com>
Date: Wed, 26 Jan 2022 19:22:15 +0100
Subject: [PATCH] add README

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..884b6b3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# Imgurs - CLI and Library for Imgur API
+
+## Screenshots
+
+![upload](https://cdn.magicuser.cf/tcqqxEh.png)
+
+![delete](https://cdn.magicuser.cf/hBqbsIm.png)
+
+## Shell completions
+
+Here are some examples of usage
+```bash
+# For bash
+imgurs completionsbash > ~/.local/share/bash-completion/completions/imgurs
+# For zsh
+imgurs completions zsh > /usr/local/share/zsh/site-functions/_imgurs
+# For fish
+imgurs completions fish > ~/.config/fish/completions/imgurs.fish
+```
+
+## How to install Imgurs CLI?
+
+### **Linux**
+Download imgurs-linux from [the releases page](https://github.com/MedzikUser/imgurs/releases/latest) and run
+
+    chmod +x imgurs-linux
+    ./imgurs-linux
+
+#### **Arch Linux**
+If you are using arch linux you can add [this repo](https://github.com/archlinux-pkg/packages) and run
+
+    sudo pacman -Sy imgurs
+
+### **OSX**
+Download imgurs-darwin from [the releases page](https://github.com/MedzikUser/imgurs/releases/latest) and run
+
+    chmod +x imgurs-darwin
+    ./imgurs-darwin
+
+### **Windows**
+Download imgurs-windows.exe from [the releases page](https://github.com/MedzikUser/imgurs/releases/latest) and run
+
+    imgurs-windows.exe
+
+### **Compile with Cargo**
+Make sure you have a recent version of Rust. Then you can run
+
+    cargo install imgurs