From 060fb7af009cd5bb830e2f851dd37d9eeb524e2a Mon Sep 17 00:00:00 2001 From: Bruno Windels Date: Tue, 29 Sep 2020 15:21:01 +0000 Subject: [PATCH] Update README.md --- README.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index aabdf89a..31addf71 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Hydrogen -A minimal [Matrix](https://matrix.org/) chat client, focused on performance, offline functionality, and broad browser support. This is work in progress and not yet ready for primetime. We're currently not accepting any externally reported issues (features, bug reports, ...) at this time. +A minimal [Matrix](https://matrix.org/) chat client, focused on performance, offline functionality, and broad browser support. This is work in progress and not yet ready for primetime. Bug reports are welcome, but please don't file any feature requests or other missing things to be on par with Element Web. ## Goals @@ -10,16 +10,8 @@ Hydrogen's goals are: - It is a standalone webapp, but can also be easily embedded into an existing website/webapp to add chat capabilities. - Loading (unused) parts of the application after initial page load should be supported -## Status - -Hydrogen can currently log you in, or pick an existing session, sync already joined rooms, fill gaps in the timeline, and send text messages. Everything is stored locally. - -## Why - -For every interaction or network response (syncing, filling a gap), Hydrogen 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`. +If you find this interesting, come and discuss on `#hydrogen:matrix.org`. # How to use -Try it locally by running `npm install dev` (only the first time) and `npm start` in the terminal, and point your browser to `http://localhost:3000`. +Try it locally by running `yarn install` (only the first time) and `yarn start` in the terminal, and point your browser to `http://localhost:3000`.