atreyabain/nodejs-fm
1
0
Fork 0
Code Issues Pull Requests Wiki Activity

README changes

Browse Source
This commit is contained in:
Atreya Bain
2019-05-27 14:21:36 +05:30
parent 69ee42e346
commit 81ad30ab51
1 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -17,7 +17,7 @@ Dependencies(testing): `chai` `mocha` `chai-http`
### Why ### Why
Personal requirement. 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. No authentication, as it is based on a small local server, and the major way of accessing it, is ssh.
## Usage ## 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 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: Requests:
```javascript ```javascript