Skip to content
This repository has been archived by the owner on Apr 22, 2024. It is now read-only.

Commit

Permalink
Improve the README.md
Browse files Browse the repository at this point in the history
Create section to show how to create a new release in the Kytos/UI
  • Loading branch information
macartur committed Sep 26, 2018
1 parent 4ff56ae commit 103af8e
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# hello

> A Vue.js project
# Kytos/UI

## Build Setup

Expand All @@ -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).

0 comments on commit 103af8e

Please sign in to comment.