Merge pull request #48 from macartur/update_readme

Improve the README.md

README.md

@@ -1,6 +1,4 @@
-# hello
-
-> A Vue.js project
+# Kytos/UI
 
 ## Build Setup
 
@@ -15,4 +13,31 @@ npm run dev
 npm run build
 ```
 
+## How to create a new release
+
+To create a new release file you need to run the command below and during the
+procedure to create a new release on github you need append the file
+latest.zip.
+
+``` bash
+# build for production and compress the file as latest.zip
+npm run build
+```
+
+After build and upload the file in the github, the Kytos has an endpoint to see
+the latest release version and download the latest.zip file from github and
+unpack it in the kytos/web-ui folder.
+
+This update command can be trigger using the kytos-utils command displayed
+below. If no version is specified the latest version of kytos/ui on github will
+be used.
+
+``` bash
+# update the kytos web-ui to latest version
+$ kytos web update
+
+# update the kytos web-ui to a specific version
+$ kytos web update <version>
+```
+
 For detailed explanation on how things work, consult the [docs for vue-loader](http://vuejs.github.io/vue-loader).