RanchiMall/webtor
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Abhishek Sinha 2018-09-09 14:59:22 +05:30 committed by GitHub
parent 61c243853e
commit c28ce0c608
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,9 +1,21 @@
<h5>WEBTORRENT</h5>
<h2>WEBTOR</h2>
<p>Webtor is a <a href="https://webtorrent.io" target="_blank">Webtorrent</a> based project leveraging FLO blockchain transaction comment feature to decentralize magnetic urls so generted when seeding a file through Webtorrent technology.</p>
<h5>To run the project follow the steps below:</h5>
<p>Step 1: In server.example.js provide correct crdentials as per your flo.conf file.</p>
<p>Step 2: Rename server.example.js to server.js</p>
To run the file
<p>IMPORTANT: You should change all the wallet addresses used in the files as your per your addresses.</p>
<p>Step 3: Run npm install</p>
<p>Step 4: Run npm start</p>
<h5>To run the file run following commands in the terminal:</h5>
<p>Step 3: npm install</p>
<p>Step 4: npm start</p>
<h5>To run the website on a specific port provide a valid port number:</h5>
<p>Step 4: PORT=3000 npm start</p>
<h5>A word from the author:</h5>
<p>Please feel free to contribute to this project. If you find any bug please make pull requests or email to abhishek@ranchimall.net</p>