Skip to content

Commit

Permalink
Make the warning bigger in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
turt2live committed Mar 9, 2022
1 parent 958099d commit 4534891
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
# matrix-events-sdk

JS/TS SDK for handling (extensible) events in Matrix

**This project is a work in progress and subject to breaking changes.**
## 🚨🚨 Project is a work in progress

The architecture and approach of this repo is still being considered and is subject to breaking
changes. Use at your own risk.

As a general guide, functionality which is foundational to events (such as text, images, etc)
should be incorporated in this repo before the more complex types. This is to ensure that the
architecture is up to the task of handling proper extensible events.

## Usage: Parsing events

Expand Down Expand Up @@ -35,11 +43,11 @@ type MyContent = M_MESSAGE_EVENT_CONTENT & {

class MyEvent extends MessageEvent {
public readonly field: string;

constructor(wireFormat: IPartialEvent<MyContent>) {
// Parse the text bit of the event
super(wireFormat);

this.field = wireFormat.content?.field;
}
}
Expand Down

0 comments on commit 4534891

Please sign in to comment.