update readme
parent
a438bc3727
commit
b76e031352
@ -1,2 +1,30 @@
|
||||
# buckets-of-fun
|
||||
|
||||
## Usage
|
||||
|
||||
`buckets-of-fun` takes a first argument of the target size.
|
||||
The following arguments are the size of the buckets required.
|
||||
|
||||
```bash
|
||||
main.js target bucket [bucket...]
|
||||
|
||||
target: volume of bucket to search for
|
||||
bucket: volume of bucket
|
||||
```
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
If node is installed, you can run directly by running:
|
||||
|
||||
```bash
|
||||
$ node ./main.js 4 3 5
|
||||
```
|
||||
|
||||
The node script can also be run from inside a docker container.
|
||||
To build and run, you can following the commands below.
|
||||
|
||||
```bash
|
||||
$ docker build . -t buckets-of-fun
|
||||
$ docker run buckets-of-fun 4 3 5
|
||||
```
|
||||
|
Loading…
Reference in New Issue