Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@mhuggins
mhuggins committed Nov 30, 2023
1 parent d44b8ce commit 7386eab
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Add `@poker-apprentice/hand-history-parser` as a dependency.

### `parseHand`

This promise-based function can be used to parse hand histories from any [support poker site](#supported-poker-sites). To use it, simply pass the contents of an individual hand history.
This promise-based function can be used to parse hand histories from any [support poker site](#supported-poker-sites). To use it, simply pass the contents of an individual hand history along with the filename.

```ts
// Assumes `hand` is a string containing the hand history file contents & `filename`
Expand Down

0 comments on commit 7386eab

Please sign in to comment.