Skip to content

Commit ebf303f

Browse files
committed
doc(readme): add information about testing and license
1 parent 419f36d commit ebf303f

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
11
# diffida
22
Rust application based on schnorrkel verification
3+
4+
### Local testing
5+
This application is hosted on [https://www.shuttle.rs/](https://www.shuttle.rs/) if you want to test it locally you can run:
6+
```sh
7+
❯ cargo shuttle run
8+
```
9+
10+
### Endpoints
11+
All details are also avaialble calling the `/doc` method
12+
13+
| Endpoint | Description |
14+
|---|---|
15+
| `/doc` | Return the swagger API definition in text/plain |
16+
| `/api/generate` | Generates mnemonic |
17+
| `/api/sign` | Sign your message |
18+
| `/api/verify` | Verify your message |
19+
20+
### License
21+
```
22+
Copyright 2023 Marco Cattaneo
23+
24+
Licensed under the Apache License, Version 2.0 (the "License");
25+
you may not use this file except in compliance with the License.
26+
You may obtain a copy of the License at
27+
28+
https://www.apache.org/licenses/LICENSE-2.0
29+
30+
Unless required by applicable law or agreed to in writing, software
31+
distributed under the License is distributed on an "AS IS" BASIS,
32+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
33+
See the License for the specific language governing permissions and
34+
limitations under the License.
35+
```

0 commit comments

Comments
 (0)