From 0298e14a3b9274eaeef3683e7f921818e3031d8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89lo=C3=AFs?= <elois@ifee.fr> Date: Sat, 17 Nov 2018 23:50:21 +0100 Subject: [PATCH] update README --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 36fbc48..80a9df8 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,21 @@ # DUP Tools front -Based on the [create-wasm-app] template to provide a full js interface using `dup-tools-wasm`, a toolbox for developers wishing to use the DUP procotole. +Based on the [create-wasm-app] template to provide a full js interface using [dup-tools-wasm], a toolbox for developers wishing to use the DUP procotole. Currently, only the document validator feature is implemented, but the `dup-tools-wasm` library already allows you to do potentially much more ! -[create-wasm-app]: https://github.com/rustwasm/create-wasm-app.git +[create-wasm-app]: https://github.com/rustwasm/create-wasm-app.git +[dup-tools-wasm]: https://git.duniter.org/tools/dup-tools-wasm + +## Supported browsers + +* Firefox +* Chrome/Chromium ## Usage +You can use DUP Tools directly on the web: [https://tools.duniter.io/dup-tools-front/](https://tools.duniter.io/dup-tools-front/). + For local use, you only need `npm` : ``` @@ -17,7 +25,10 @@ npm start Then open `localhost:8080` in a supported browser. -## Supported browsers +### Change port -* Firefox -* Chrome/Chromium +If you are already using port `8080` for your development, you can change the port by modifying `package.json` file as follows : + +In the `scripts` section, modify the `start` command: + +Replace `"start": "webpack-dev-server"` by `"start": "webpack-dev-server --port NEW_PORT"` -- GitLab