From eece11356111dd4f4f7c7f65dd1bd2c61643bd01 Mon Sep 17 00:00:00 2001
From: "Mr. Is" <isaac.ardis@gmail.com>
Date: Wed, 27 Jul 2016 13:58:17 -0400
Subject: [PATCH] :floppy_disk:

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a272421
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Gogs CLI
+
+Accesses the Gogs Client API, currently available on Gogs' `develop` branch.
+
+Cobra & Viper go packages handle the hard work for the CLI interface.
+
+Very much still a __work in progress__. That's in bold.
+
+## Setup
+
+Clone the repo and build it yourself, or `go get github.com/irstacks/gogs-cli`.
+
+Make sure the `gogs` executable is available somewhere in your `$PATH`.
+
+This repo's build is for darwin. You can build for linux with the nifty `env GOOS=linux go build -o gogs`.
+
+## Usage
+
+So far...
+
+```bash
+$ gogs repo # index all your repos
+$ gogs repo -n my-new-repo
+$ gogs repo -o anorganizationiown -n my-new-repo
+```
+
+## Help out
+
+Pull request at will.