documentation (README): update README

README.md

@@ -1,39 +1,42 @@
-# Nuage
-
-Call it an FTP client, an S3 viewer or a Dropbox like web app, Nuage leverages your existing storage to help you manage your files in the cloud using any of the following protocols/platforms:
-
-<p align="center">
-  FTP • SFTP • WebDAV • Git • S3 <br>
-  Dropbox • Google Drive
-</p>
-
 ![screenshot](https://raw.githubusercontent.com/mickael-kerjean/nuage/master/.assets/img/photo.jpg)
 
-<h1 align="center">
-  <a href="https://nuage.kerjean.me"> DEMO </a>
-</h1>
+<p align="center">
+    A Dropbox-like file manager that let you manage your data anywhere it is located:<br>
+    FTP • SFTP • WebDAV • Git • S3 <br>
+        Dropbox • Google Drive
+</p>
+<p align="center">
+    <i>Yes we have a</i> <b><a href="https://nuage.kerjean.me">DEMO</a></b>
+</p>
+
 
 # Features
-- manage your files directly from your browser
-- work with multiple cloud providers and protocols, easily extensible
-- upload files and folders
-- mobile friendly
-- super fast
-- audio player
-- video player
-- image viewer
-- emacs keybindings `;)`
+- Manage your files directly from your browser
+- User friendly
+- Super fast
+- Works offline
+- Upload files and folders
+- Works great on mobile
+- Multiple cloud providers and protocols, easily extensible
+- Audio player
+- Video player
+- Image viewer
+- Emacs keybindings + [org mode](https://orgmode.org/) friendly `;)`
+- Frequently access folders are pin to the homepage for quick access
+- Customise the connection page so that your users don't even have to know what protocol to use and where it is located ([example](http://files.kerjean.me))
+- Stateless (perfect candidate for AWS lamdba if that's your thing)
 
 # Install
-It's a simple react app with node in the backend. Installation requires docker, docker-compose and npm:
+Nuage is a react app with node in the backend. Installation:
 ```
-# get the code
-curl -L -X GET https://github.com/mickael-kerjean/nuage/archive/master.zip > nuage.zip
-unzip nuage.zip && cd nuage-master
-# install dependencies and create the actual image
-npm run image && npm run start
+git clone https://github.com/mickael-kerjean/nuage
+cd nuage
+npm install
+npm run build
+node server/index.js
 ```
-That's it !
+
+Or with [docker](https://hub.docker.com/r/machines/nuage/) and [Docker compose](https://github.com/mickael-kerjean/nuage/blob/master/docker/docker-compose.yml)
 
 # What about my credentials?
 Credentials are stored in your browser in a http only cookie encrypted using aes-256-cbc and aren't persistent in the server disk at all.

docker/Dockerfile

@@ -3,6 +3,7 @@ MAINTAINER mickael.kerjean@gmail.com
 
 COPY . /app
 WORKDIR "/app"
+ENV NODE_ENV production
 
 RUN cd /app/ && \
     # remove dev stuff
@@ -18,5 +19,5 @@ RUN cd /app/ && \
     apt-get -y clean && \
     apt-get -y purge --auto-remove build-essential automake python && \
     rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
-    
+
 CMD ["node", "/app/server/index"]

docker/docker-compose.yml

@@ -2,10 +2,9 @@ version: '2'
 services:
   app:
     container_name: nuage
-    image: nuage
+    image: machines/nuage
     restart: always
     environment:
-    - NODE_ENV=production
     - SECRET_KEY=my_secret_key
     ports:
     - "10006:3000"

package.json

@@ -5,12 +5,10 @@
   "repository": "https://github.com/mickael-kerjean/nuage",
   "main": "server/index.js",
   "scripts": {
-    "dev": "webpack-dev-server --config webpack.config.js --progress --inline --hot --host 0.0.0.0",
+    "dev": "webpack --watch",
     "build": "NODE_ENV=production webpack -p",
-    "image": "docker build -t nuage -f ./docker/img/Dockerfile .",
+    "image": "docker build -t nuage -f ./docker/Dockerfile .",
     "publish": "docker tag nuage machines/nuage && docker push machines/nuage",
-    "start": "cd docker && docker-compose up -d",
-    "stop": "cd docker && docker-compose down",
     "clean": "rm -rf server/public/js server/public/*.html || true",
     "clear": "npm run clean && rm -rf node_modules"
   },