diff --git a/README.md b/README.md index 8bdd7a9..9a95f8b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,48 @@ # About -`repertory-js` is a client library used to communicate with `repertory's` remote API. -## Example Usage -``` javascript +`repertory-js` is a Node.js module for interfacing with `repertory's` remote mount API. + +## Installing + +```shell +npm i @scottg1/repertory-js +``` + +## Repertory Configuration + +A Repertory mount must be active with the `EnableRemoteMount` setting enabled. `RemoteToken` should +also be set to a strong, random password. + +### Enabling Sia Remote Mount API on Windows Systems + +```shell + repertory.exe -unmount + repertory.exe -set RemoteMount.EnableRemoteMount true + repertory.exe -set RemoteMount.RemoteToken "my password" + + [Optional - change listening port] + repertory.exe -set RemoteMount.RemotePort 202020 +``` + +### Enabling Sia Remote Mount API on *NIX Systems + +```shell + ./repertory -unmount + ./repertory -set RemoteMount.EnableRemoteMount true + ./repertory -set RemoteMount.RemoteToken "my password" + + [Optional - change listening port] + ./repertory -set RemoteMount.RemotePort 202020 +``` + +### Skynet and ScPrime Mounts + +* For Skynet mounts, add `-sk` argument to all commands listed above. +* For ScPrime mounts, add `-sp` argument to all commands listed above. + +## Example API Usage + +```javascript const rep = require('@scottg1/repertory-js'); @@ -66,4 +106,4 @@ await api.file.download('/my_file.txt', 'C:\\my_file.txt', progress_cb, false, t // Upload a local file await api.file.upload('C:\\my_file.txt', '/my_file.txt', progress_cb); -``` \ No newline at end of file +``` diff --git a/package.json b/package.json index e7675ea..89439b7 100644 --- a/package.json +++ b/package.json @@ -1,16 +1,23 @@ { "name": "@scottg1/repertory-js", "version": "1.3.1-r1", - "description": "Repertory Library for Remote Mount API", + "description": "A Node.js module for interfacing with Repertory's remote mount API", "scripts": { "test": "jest" }, "keywords": [ - "siacoin", - "sia", - "scprime", "repertory", - "library" + "repertory-ui", + "library", + "mount", + "fuse", + "winfsp", + "blockchain", + "decentralized", + "cloud", + "storage", + "altcoin", + "cryptocurrency" ], "author": "scott.e.graves@protonmail.com", "homepage": "https://bitbucket.org/blockstorage/repertory-js",