From 7f94b49f0c7fa9219d58f10b5e1c419104e2e01b Mon Sep 17 00:00:00 2001 From: Erich Kaestner <36450093+jdknives@users.noreply.github.com> Date: Fri, 17 Apr 2020 11:55:08 +0200 Subject: [PATCH] doc cleanup --- CHANGELOG.md | 26 ++++++++++++++++++-------- CONTRIBUTING.md | 9 --------- cmd/hypervisor/README.md | 2 +- static/skywire-manager-src/README.md | 6 ++---- 4 files changed, 21 insertions(+), 22 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 99e8daa5a8..a82107520d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,22 +4,32 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). -## [Unreleased] +## 0.2.1 - 2020.04.07 + +### Changed + +- reverted port changes for `skysocks-client` + +## 0.2.0 - 2020.04.02 ### Added -- Retry logic to messaging server for messaging client. +- added `--retain-keys` flag to `skywire-cli visor gen-config` command +- added `--secret-key` flag to `skywire-cli visor gen-config` command +- added hypervisorUI frontend +- added default values for visor if certain fields of config are empty ### Fixed -- Fixed channel collision for messaging clients. +- fixed deployment route finder HTTP request +- fixed /user endpoint not working when auth is disabled ### Changed -- Improve readability of Skywire CLI output. - -## 0.1.0 - 2019.03.04 +- changed port of hypervisorUI and applications +- replaced unix sockets for app to visor communication to tcp sockets +- reverted asynchronous sending of router packets -### Added +## 0.1.0 - 2020.04.02 -- First release of the mainnet Skywire visor and apps for testing. +First release of Skywire Mainnet. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 2ef2729d01..0000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,9 +0,0 @@ -# How to help: - -Interested developers can help by running the software and using the applications to test the functionality. They can file bug -issues in case something is not working. Bug issues should include a description of the bug, steps to reproduce and should -have [Mainnet] in the title so they can be filtered more easily. We will fix bugs as soon as possible. - -As soon as the documentation is released, we will provide guides on how to help the development of Skywire, whether it is a -new transport implementation or an application developed on Skywire. Bounties will be available for completion of certain -tasks. diff --git a/cmd/hypervisor/README.md b/cmd/hypervisor/README.md index d37a25be4d..697e45c958 100644 --- a/cmd/hypervisor/README.md +++ b/cmd/hypervisor/README.md @@ -22,7 +22,7 @@ Endpoints are documented in the provided [Postman](https://www.getpostman.com/) ## Web UI -UI is served on the same port as the API (`:8000` by default). Directory to search for the build frontend is passed in the `web_dir` field of the hypervisor's config. +UI is served on the same port as the API (`:8000` by default). ### Authentication information diff --git a/static/skywire-manager-src/README.md b/static/skywire-manager-src/README.md index 1666530652..cf1a4b7473 100644 --- a/static/skywire-manager-src/README.md +++ b/static/skywire-manager-src/README.md @@ -1,8 +1,6 @@ # Skywire Manager -Frontend application that allows to manage a group of Skywire nodes through a Hypervisor instance. - -Note: The software is still under heavy development and the current version is intended for public testing purposes only. +Frontend application that allows to manage a group of Skywire visors through a Hypervisor instance. ## Prerequisites @@ -38,7 +36,7 @@ change any of the source files. ## Build -Run `npm run build` to build the project. The build artifacts will be stored in the `dist/` directory. +Run `make build-ui` in the top directory of this repo to rebuild the UI. The build artifacts will be stored in the `dist/` directory. ## Translations