diff --git a/README.md b/README.md index 328ffbd..c6c900f 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,29 @@ # wtshare - WebTorrent Share -This project can be used with JS only, but if you like you can use `docker` and `docker-compose` to deploy +You can share files from the browser with P2P technology ([WebTorrents](https://webtorrent.io/)) without installing anything, there is no size limit -### Configuration and Recommendations +![wtshare](capture.png) -``` -If you want to use this project consider using it behind a proxy, you need to set some variables in the `main.js` file to work properly -``` +This project can be used with NodeJS only, but if you like you can use `docker` and `docker-compose` to deploy -### Build +## Configuration and Recommendations + +- If you want to use in production consider using it behind a proxy +- You need to set some variables in the `public/js/main.js` file to work properly + + +## Build ```bash docker-compose build --no-cache ``` -### Run +## Run ```bash docker-compose up -d ``` -### License +## License MIT diff --git a/capture.png b/capture.png new file mode 100644 index 0000000..09ff810 Binary files /dev/null and b/capture.png differ diff --git a/public/js/main.js b/public/js/main.js index 3778a71..b08c547 100644 --- a/public/js/main.js +++ b/public/js/main.js @@ -3,7 +3,7 @@ var downloadTorrent = function (torrent) { } $(document).ready(function () { var trackers = [ - 'ws://0.0.0.0:8888' + 'ws://0.0.0.0:8888', 'http://0.0.0.0:8888/announce' ], iceServers = [