Skip to content

Commit

Permalink
UPD readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
katekorsaro committed Jan 17, 2024
1 parent 6f6e6dc commit 386cbb2
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,13 @@

# iron-dice

CLI die roller
A CLI die roller for every RPG enthusiast.

## Usage

- `iron_dice` will yield the result of 3d6
- `iron_dice "d20"` will throw and yield 1d20
- `iron_dice "d100+40"` will throw and yield 1d100 and will add 40 to the result
- `iron_dice "5d6 sc6"` will throw 5d6 and for every 6 will count 1 success
- `iron_dice "4d6 max3"` will throw 4d6 keeping the largest 3
- `iron_dice "3d8 ex7"` will throw 3d8 and explode every die showing 7 or more

0 comments on commit 386cbb2

Please sign in to comment.