From 5ea21831c63d3bb78ff97c9b11ecf0ca296ecef6 Mon Sep 17 00:00:00 2001 From: Bruno Windels Date: Sun, 8 Sep 2019 11:54:18 +0200 Subject: [PATCH] add usage instructions --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index e95beeb9..45316c22 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,7 @@ Brawl can currently log you in, or pick an existing session, sync already joined I started writing Brawl both to have a functional matrix client on my aging phone, and to play around with some ideas I had how to use indexeddb optimally in a matrix client. For every interaction or network response (syncing, filling a gap), Brawl starts a transaction in indexedb, and only commits it once everything went well. This helps to keep your storage always in a consistent state. As little data is kept in memory as well, and while scrolling in the above GIF, everything is loaded straight from the storage. If you find this interesting, feel free to reach me at `@bwindels:matrix.org`. + +# How to use + +I haven't made a deployment script yet for this, so for now you need to locally `yarn start` or `npm start` and point your browser to `http://localhost:3000`.