From 81ad30ab5185aa65874c0f191c00cd377ed2105b Mon Sep 17 00:00:00 2001 From: Christopher Rose Date: Mon, 27 May 2019 14:21:36 +0530 Subject: [PATCH] README changes --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 145960a..ac21577 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Dependencies(testing): `chai` `mocha` `chai-http` ### Why Personal requirement. -Because of this, only renaming is available, and uploading/downloading. +Because of this, only renaming/moving(only in same fs, due to `fs.rename()`) is available, and uploading/downloading. No authentication, as it is based on a small local server, and the major way of accessing it, is ssh. ## Usage @@ -26,6 +26,23 @@ Use `settings.json` and point it to a valid address, and select a required port. For the backend, the jsons have this form. +For running it: + +```shell +# Clone repo +git clone https://github.com/chrisvrose/nodejs-fm.git +# Move into repo folder +cd nodejs-fm/ +# Setup the project +npm i +# Your own config, start with settings.json +#... +# Start the server +npm start +``` + +### Server requests + Requests: ```javascript