Skip to content

Commit

Permalink
chore: update readme/changelog
Browse files Browse the repository at this point in the history
Signed-off-by: Patrick Lee Scott <[email protected]>
  • Loading branch information
patrickleet committed Aug 25, 2021
1 parent a7937e1 commit 8fe0e7a
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# sourced v4
- Typescript rewrite - thanks to work on this at https://github.com/PDMLab/sourced-ts
- Typescript rewrite - thanks to work on this at https://github.com/PDMLab/sourced-ts by @alexander.zeitler and @stephanknull, pulled in by @patrickleet
- BREAKING CHANGE: now publishes ESM and CJS modules at /dist/esm and /dist/cjs

# sourced v3
- Browser support by using `eventemitter3.EventEmitter` instead of Node `events.EventEmitter`
- Browser support by using `eventemitter3.EventEmitter` instead of Node `events.EventEmitter` by @patrickleet
- BREAKING CHANGE: `Entity` is now `EntityProxy`. `SourcedEntity` is now `Entity`

# sourced v2
Expand Down
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -403,3 +403,22 @@ const Entity = require('sourced').EntityProxy
```

See examples directory for an examply of using the `EntityProxy` - run it with `npm ci && npm run build && node examples/auth/example.js`

# Upgrading

## sourced v4
- Typescript rewrite - thanks to work on this at https://github.com/PDMLab/sourced-ts by @alexander.zeitler and @stephanknull, pulled in by @patrickleet
- BREAKING CHANGE: now publishes ESM and CJS modules at /dist/esm and /dist/cjs

## sourced v3
- Browser support by using `eventemitter3.EventEmitter` instead of Node `events.EventEmitter` by @patrickleet
- BREAKING CHANGE: `Entity` is now `EntityProxy`. `SourcedEntity` is now `Entity`

## sourced v2
- updated to ES6 syntax by @patrickleet
- `SourcedEntity` an ES6 implementation of `Entity` added.
- `Entity` is now just a proxy to the new `SourcedEntity` ES6 class.
- Deprecation notice: `SourcedEntity` will become `Entity` in the next major version, and `Entity`, which is now a proxy, left for backwards compatibility

## sourced v1
- original lib by @mateodelnorte - battle tested in financial systems that tranact billions of dollars.

0 comments on commit 8fe0e7a

Please sign in to comment.