From 4c34aa1ef05eaab4ee55e584fe074c8034be856a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89lo=C3=AFs?= <elois@ifee.fr> Date: Sat, 17 Nov 2018 22:41:40 +0100 Subject: [PATCH] add README --- README.md | 41 +++++++++++++++++------------------------ 1 file changed, 17 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index fea416e..36fbc48 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,23 @@ -# create-wasm-app -> an npm init project for generating a project that consumes rust-generated wasm via webpack +# 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. + +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 ## Usage +For local use, you only need `npm` : + ``` -npm init wasm-app +npm install +npm start ``` -## What's Included - -- `.gitignore`: ignores `node_modules` -- `LICENSE-APACHE` and `LICENSE-MIT`: most Rust projects are licensed this way, so these are included for you -- `README.md`: the file you are reading now! -- `index.html`: a bare bones html document that includes the webpack bundle -- `index.js`: example js file with a comment showing how to import and use a wasm pkg -- `package.json` and `package-lock.json`: - - pulls in devDependencies for using webpack: - - [`webpack`](https://www.npmjs.com/package/webpack) - - [`webpack-cli`](https://www.npmjs.com/package/webpack-cli) - - [`webpack-dev-server`](https://www.npmjs.com/package/webpack-dev-server) - - defines a `start` script to run `webpack-dev-server` -- `webpack.config.js`: configuration file for bundling your js with webpack - -### Contribution - -Unless you explicitly state otherwise, any contribution intentionally -submitted for inclusion in the work by you, as defined in the Apache-2.0 -license, shall be dual licensed as above, without any additional terms or -conditions. +Then open `localhost:8080` in a supported browser. + +## Supported browsers + +* Firefox +* Chrome/Chromium -- GitLab