From da8d272700208311a0a87dda9b82cf2958fe9845 Mon Sep 17 00:00:00 2001
From: Assorium <mrspartak@users.noreply.github.com>
Date: Thu, 13 Feb 2020 18:15:29 +0300
Subject: [PATCH] Update README.md

---
 README.md | 53 +++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 41 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index 8f37bc6..98416b9 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,48 @@
-# cdn-js-frontend-v4
+# Web page for Granny nodejs CDN server
 
-## Project setup
-```
-npm install
-```
+This app helps to setup your mini CDN. Add domains, setup settings and view your files
+
+[![Docker Cloud Automated build](https://img.shields.io/docker/cloud/automated/assorium/granny-server-web?style=for-the-badge "Docker Cloud Automated build")](https://hub.docker.com/r/assorium/granny-server-web "Docker Cloud Automated build")
+[![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/assorium/granny-server-web?style=for-the-badge "Docker Cloud Build Status")](https://hub.docker.com/r/assorium/granny-server-web "Docker Cloud Build Status")
+[![Docker Pulls](https://img.shields.io/docker/pulls/assorium/granny-server-web?style=for-the-badge "Docker Pulls")](https://hub.docker.com/r/assorium/granny-server-web "Docker Pulls")  <br/>
+
+[![Latest Github tag](https://img.shields.io/github/v/tag/mrspartak/granny-server-frontend?sort=date&style=for-the-badge "Latest Github tag")](https://github.com/mrspartak/granny-server-frontend/releases "Latest Github tag")
+
+## Ecosystem
+![image](https://user-images.githubusercontent.com/993910/74383777-e8261d80-4e00-11ea-8373-25070ec1ca97.png)
 
-### Compiles and hot-reloads for development
+[granny-server-backend](https://github.com/mrspartak/granny-server-backend "granny-server-backend") - Backend service with API exposed to upload and serve/manipulate images  
+[granny-js-client](https://github.com/mrspartak/granny-js-client "granny-js-client") - Client library that works both in nodejs and browser. Makes API calls easier  
+[granny-server-frontend](https://hub.docker.com/repository/docker/assorium/granny-server-web "granny-server-frontend") - Frontend APP that uses client to manage your CDN domains and settings  
+
+## Requirements
+- [Granny backend server running](https://github.com/mrspartak/granny-server-backend)
+
+## Docker install
+There is builded vue website inside container with small nginx image to serve. So website is avialable on 80 port and you can easily proxy it with external nginx.
+You can also run this as a service and pass --config to it
 ```
-npm run serve
+docker run -p 3010:80 --name granny-server-frontend \
+  -v /local/path/to/settings.json:/usr/share/nginx/html/cfg/settings.json \
+  assorium/granny-server-web:latest
 ```
-
-### Compiles and minifies for production
+Settings file looks like this:
 ```
-npm run build
+{
+	"granny_url": "https://path to your granny backend server"
+}
 ```
 
-### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
+## Current status
+Currently this is in deep beta. I needed this website to setup domains and list files. And there are many things to do. I will definately make them later.
+- View files and all modifications
+- Setup domains settings. Such as 'save modified images', 'return headers', 'allowed modifications' etc
+- Adding users?
+- Showing app hardware usage inforamtion
+
+## Screenshots
+Adding domain
+![image](https://user-images.githubusercontent.com/993910/74448612-4f3ce400-4e8c-11ea-8e87-72fdc899f513.png)
+
+Listing files
+![image](https://user-images.githubusercontent.com/993910/74448675-6aa7ef00-4e8c-11ea-8e2f-5c021c8f545f.png)