From 103af8e69d377aaed0357a5fe623b9733577ea26 Mon Sep 17 00:00:00 2001 From: Macartur Sousa Date: Wed, 26 Sep 2018 13:51:48 -0300 Subject: [PATCH] Improve the README.md Create section to show how to create a new release in the Kytos/UI --- README.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ba925b8..000cc3a 100644 --- a/README.md +++ b/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 +``` + For detailed explanation on how things work, consult the [docs for vue-loader](http://vuejs.github.io/vue-loader).