@randsum/fifth 0.23.0 → 0.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +4 -3
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -32,7 +32,7 @@ bun add @randsum/fifth
32
32
  ## Usage
33
33
 
34
34
  ```typescript
35
- import { roll, meetOrBeat } from "@randsum/fifth"
35
+ import { roll } from "@randsum/fifth"
36
36
  import type { RollArgument } from "@randsum/fifth"
37
37
 
38
38
  // Basic roll with modifier
@@ -55,7 +55,8 @@ const rollArg: RollArgument = {
55
55
  modifier: 5,
56
56
  rollingWith: "Advantage"
57
57
  }
58
- meetOrBeat(15, rollArg) // Returns true if roll meets or exceeds DC 15
58
+ const result = roll(rollArg)
59
+ const success = result.total >= 15 // Check if roll meets or exceeds DC 15
59
60
  ```
60
61
 
61
62
  ## API Reference
@@ -72,7 +73,7 @@ const result = d20Roll({
72
73
  // Returns a roll result with total and details
73
74
  ```
74
75
 
75
- We also export the `roll` and `meetOrBeat` functions from `@randsum/roller` for your convenience.
76
+ We also export the `roll` function from `@randsum/roller` for your convenience.
76
77
 
77
78
  ## Related Packages
78
79
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@randsum/fifth",
3
- "version": "0.23.0",
3
+ "version": "0.24.0",
4
4
  "description": "A flexible, type-safe dice roller for building 5E-compatible applications",
5
5
  "private": false,
6
6
  "author": {
@@ -28,7 +28,7 @@
28
28
  "sideEffects": false,
29
29
  "type": "module",
30
30
  "dependencies": {
31
- "@randsum/roller": "~0.23.0"
31
+ "@randsum/roller": "~0.24.0"
32
32
  },
33
33
  "exports": {
34
34
  ".": {