Commit a2188a74 authored by Millicent Billette's avatar Millicent Billette

[doc] README.md avec présentation, prérequis, tuto d'utilisation (WiP) et de contribution

parent 5829c9c2
Pipeline #4081 passed with stages
in 5 minutes and 55 seconds
......@@ -2,7 +2,64 @@
# DUP Tools
Tools for DUP Protocol.
A tools box lib for DUP (Dividend Universal Protocol) in WebAssembly (WASM).
- Rust **reliability**
- WebAssembly **performances**
- Javascript **wide usability**
You can use DUP tools directly in [modern browsers](https://caniuse.com/#feat=wasm) or server side with [node.js](https://nodejs.org/).
#### Project state
[![npm version](https://img.shields.io/npm/v/dup-tools-wasm.svg)](https://www.npmjs.com/package/dup-tools-wasm)
[![pipeline status](https://git.duniter.org/tools/dup-tools-wasm/badges/master/pipeline.svg)](https://git.duniter.org/tools/dup-tools-wasm/commits/master)
[![coverage report](https://git.duniter.org/tools/dup-tools-wasm/badges/master/coverage.svg)](https://git.duniter.org/tools/dup-tools-wasm/commits/master)
## 📝 Usage
[Full usage exemple with online demo](https://git.duniter.org/tools/dup-tools-front#readme)
### ⚡ Quick start guide
1. install [npm](https://www.npmjs.com/get-npm)
2. Create an empty folder for your project, and open a terminal in it.
3. To install `dup-tools-wasm` run
```bash
npm install dup-tools-wasm
```
4. create a js file `myFirstExperiment.js` with the following code :
```javascript
import * as dup from "dup-tools-wasm";
const keypair = dup.generate_ed25519_keypair("salt", "password");
console.log(keypair);
```
>>> WiP
5. ![Fork](http://forked.yannick.io/images/favicon.png) for in browser use case :
create an html file `index.html` with the following code :
```html
<meta charset="utf-8"/>
<h1>See your console result (F12 by default)</h1>
<script module src="myFirstExperiment.js"></script>
```
5. ![Fork](http://forked.yannick.io/images/favicon.png) for node.js use case :
>>> End WiP
## Contribute
### 🔮 Prerequisites
You need [wasm-pack](https://github.com/rustwasm/wasm-pack#--wasm-pack) and it prerequisites ([Rust and npm](https://rustwasm.github.io/wasm-pack/book/prerequisites/index.html))
### 🛠️ Build with `wasm-pack build`
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment