diff --git a/README.md b/README.md index 877c817..351a110 100644 --- a/README.md +++ b/README.md @@ -1 +1,39 @@ -# bitburner-remote \ No newline at end of file +# bitburner-filesync + +A file synchronisation utility for Bitburner, using the Remote File API. + +It allows players to synchronize scripts and text files from their computer's disk to the game in both the Electron build and website. + +## How to use (for users) +You must have a recent version of `npm` installed after which you can run +``` +npx bitburner-filesync +``` + +This pulls and runs the latest release of bitburner-filesync for you. + +## Configuration + +The program, when ran, uses a local file to have itself configured to your preferences. +This file is `filesync.json` within the directory you start bitburner-filesync. + +Here's an example of it's contents: + +```js +{ + "allowedFiletypes": [ + ".js", + ".script", + ".txt" + ], + "allowDeletingFiles": false, + "port": 12525, + "scriptsFolder": ".", + "quiet": false, + "dry": false, + "definitionFile": { + "update": false, + "location": "NetScriptDefinitions.d.ts" + } +} +``` diff --git a/npx/bitburner-remote.js b/npx/bitburner-filesync.js similarity index 100% rename from npx/bitburner-remote.js rename to npx/bitburner-filesync.js diff --git a/package.json b/package.json index 2ac4eb0..cb06b98 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,10 @@ { - "name": "bitburner-remote", - "version": "1.0.7", - "description": "Official implementation of the Bitburner Remote Server", + "name": "bitburner-filesync", + "version": "1.0.0", + "description": "Official implementation of the Bitburner Filesync server", "type": "module", - "bin": "./npx/bitburner-remote.js", - "main": "./npx/bitburner-remote.js", + "bin": "./npx/bitburner-filesync.js", + "main": "./npx/bitburner-filesync.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "start": "node src/index.js" @@ -18,12 +18,11 @@ "rfa", "remote" ], - "author": "Zoƫ Hoekstra", "license": "Unlicense", "bugs": { - "url": "https://github.com/Hoekstraa/bitburner-remote/issues" + "url": "https://github.com/bitburner-official/bitburner-filesync/issues" }, - "homepage": "https://github.com/Hoekstraa/bitburner-remote#readme", + "homepage": "https://github.com/bitburner-official/bitburner-filesync#readme", "dependencies": { "cheap-watch": "^1.0.4", "convict": "^6.2.3",