Skip to content

Commit

Permalink
readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
kbjr committed Mar 19, 2022
1 parent af1cfdd commit 40d3f54
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@ Fully extensible, you can create custom versions of any component to make differ

### Version 2

This is a beta branch for the v2 rewrite. The primary purpose of the rewrite is the update to TypeScript, as well as some general refactoring.
Version 2 has now been released. Short list of some of the notable changes:

- Rewrite in TypeScript
- New customizable randomization source. The previous options related to RNG have been removed, and a new `RandomGenerator` interface exists to enable providing a custom RNG implementation. Built-in implementations are provided for `Math.random()` and the node.js `crypto` module's `pseudoRandomBytes()` as randomization sources.
- Some thing have moved around to new locations
- With TypeScript came a switch to using TypeDoc for documentation generation, so docs look different now
- Now has **no runtime dependencies** (check the package.json)

### Install

Expand Down

0 comments on commit 40d3f54

Please sign in to comment.