diff --git a/LICENSE b/LICENSE index 766f7dd..73d6d0b 100644 --- a/LICENSE +++ b/LICENSE @@ -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 diff --git a/README.md b/README.md index 671a291..b2823c4 100644 --- a/README.md +++ b/README.md @@ -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 +``` + +### 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.