RanchiMall/FLO-signValidator
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update ReadMe

Browse Source
This commit is contained in:
sairajzero 2021-08-03 16:04:07 +05:30
parent 4fb08af7cf
commit 231cf0d8b9
2 changed files with 24 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
LICENSE
View File

@ -1,6 +1,6 @@
MIT License
Copyright (c) 2021 ranchimall
Copyright (c) 2021 RanchiMall
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

25
README.md
View File

@ -1,7 +1,28 @@
# FLO-signValidator
The server will verify the signature sent via POST request.
This nodejs Server will verify the signature sent via POST request.
The post request must consist of a JSON string with the following:
## Installation (for server host only)
### Pre-requisite
- [X] Nodejs `version >= 12.9`
### Download
Download the repository using git:
```
git clone https://github.com/ranchimall/FLO-signValidator.git
```
## Starting the server
The server can be started using the following command
```
node ./start.js
```
The default port is 8080. To host the server in different port, pass the port number in command line argument as shown below
```
node ./start.js <port>
```
### Usage
The POST request must consist of a JSON string with the following:
- floID: floID of the signer.
- pubKey: pubKey of the signer.
- message: message that was signed.