From 46299bef765e04be3adafa704a6f8f7ee088a928 Mon Sep 17 00:00:00 2001
From: "Nicholas St. Germain" <nick@cajun.pro>
Date: Mon, 10 Dec 2018 21:54:01 -0600
Subject: [PATCH] updated readme + travis. Also addresses #53

---
 .travis.yml |  2 +-
 README.md   | 74 ++++++++++++++++++++++++++++++++++++++++++-----------
 2 files changed, 60 insertions(+), 16 deletions(-)

diff --git a/.travis.yml b/.travis.yml
index 6e28370..f746698 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -3,7 +3,7 @@ services:
 
 script:
   - docker build -t boerderij/varken:$TRAVIS_BRANCH .
-  - docker ps -a
+  - docker images
   - echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
   - docker push boerderij/varken:$TRAVIS_BRANCH
 
diff --git a/README.md b/README.md
index eb16bc3..838724d 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # Varken
+[![Build Status](https://travis-ci.org/Boerderij/Varken.svg?branch=master)](https://travis-ci.org/Boerderij/Varken)
 [![Discord](https://img.shields.io/badge/Discord-Varken-7289DA.svg?logo=discord&style=flat-square)](https://discord.gg/AGTG44H)
 [![BuyMeACoffee](https://img.shields.io/badge/BuyMeACoffee-Donate-ff813f.svg?logo=CoffeeScript&style=flat-square)](https://www.buymeacoffee.com/varken)
-[![Docker Pulls](https://img.shields.io/docker/pulls/boerderij/varken.svg?style=flat-square)](https://hub.docker.com/r/boerderij/varken/)
 
 Dutch for PIG. PIG is an Acronym for Plex/InfluxDB/Grafana
 
@@ -12,28 +12,47 @@ frontend
 Requirements:
 * Python3.6+
 * Python3-pip
+* InfluxDB
 
 <p align="center">
 <img width="800" src="https://i.imgur.com/av8e0HP.png">
 </p>
 
-## Quick Setup
-1. Clone the repository `sudo git clone https://github.com/Boerderij/Varken.git /opt/Varken`
-1. Follow the systemd install instructions located in `varken.systemd`
-1. Create venv in project `cd /opt/Varken && /usr/bin/python3 -m venv varken-venv`
-1. Install requirements `/opt/Varken/varken-venv/bin/python -m pip install -r requirements.txt`
-1. Make a copy of `varken.example.ini` to `varken.ini` in the `data` folder
-   `cp /opt/Varken/data/varken.example.ini /opt/Varken/data/varken.ini`
-1. Make the appropriate changes to `varken.ini`
-   ie.`nano /opt/Varken/data/varken.ini`
-1. Make sure all the files have the appropriate permissions `sudo chown varken:varken -R /opt/Varken`
-1. After completing the [getting started](http://docs.grafana.org/guides/getting_started/) portion of grafana, create your datasource for influxdb.
-1. Install `grafana-cli plugins install grafana-worldmap-panel`
+## Quick Setup (Git Clone)
+```
+# Clone the repository
+git clone https://github.com/Boerderij/Varken.git /opt/Varken
 
+# Follow the systemd install instructions located in varken.systemd
+nano /opt/Varken/varken.systemd
+cp /opt/Varken/varken.systemd /etc/systemd/system/varken.service
+
+# Create venv in project
+/usr/bin/python3 -m venv /opt/Varken/varken-venv
+
+# Install requirements
+/opt/Varken/varken-venv/bin/python -m pip install -r requirements.txt
+
+# Make a copy of varken.example.ini to varken.ini in the data folder
+cp /opt/Varken/data/varken.example.ini /opt/Varken/data/varken.ini
+
+# Make the appropriate changes to varken.ini
+nano /opt/Varken/data/varken.ini
+
+# Make sure all the files have the appropriate permissions
+chown $USER:$USER -R /opt/Varken
+
+# Start the service and enable it
+systemctl start varken
+systemctl enable varken
+```
 ### Docker
 
 Repo is included in [Boerderij/docker-Varken](https://github.com/Boerderij/docker-Varken)
-
+[![Docker-Layers](https://images.microbadger.com/badges/image/boerderij/varken.svg)](https://microbadger.com/images/boerderij/varken")
+[![Docker-Version](https://images.microbadger.com/badges/version/boerderij/varken.svg)](https://microbadger.com/images/boerderij/varken")
+[![Docker Pulls](https://img.shields.io/docker/pulls/boerderij/varken.svg)](https://hub.docker.com/r/boerderij/varken/)
+[![Docker Stars](https://img.shields.io/docker/stars/boerderij/varken.svg)](https://hub.docker.com/r/boerderij/varken/)
 <details><summary>Example</summary>
 <p>
 
@@ -42,7 +61,32 @@ docker run -d \
   --name=varken \
   -v <path to data>:/config \
   -e PGID=<gid> -e PUID=<uid>  \
-  boerderij/varken:nightly
+  boerderij/varken
 ```
 </p>
 </details>
+
+#### Tags
+* **latest**
+* **nightly**
+* **release-tag** e.g. v1.0
+
+#### Upgrading with docker
+```sh
+docker stop varken
+docker rm varken
+# Run deploy command above
+```
+
+### InfluxDB
+[InfluxDB Installation documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/)
+Influxdb is required but not packaged as part of Varken. Varken will create
+its database on its own. If you choose to give varken user permissions that
+do not include database creation, please ensure you create an influx database
+named `varken`
+
+### Grafana
+Grafana is used in our examples but not required, nor packaged as part of
+Varken. Panel example pictures are pinned in the grafana-panels channel of
+discord. Future releases may contain a json-generator, but it does not exist
+as varken stands today.
\ No newline at end of file