From 2accab9cb4dab3242527de78e3e1d40f31077dc1 Mon Sep 17 00:00:00 2001 From: Bruno Windels Date: Wed, 5 Aug 2020 18:17:35 +0100 Subject: [PATCH] WIP --- README.md | 10 +++++++++- TODO.md | 13 +++++++++++++ 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 TODO.md diff --git a/README.md b/README.md index 5572ae31..a02e6cd4 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ A minimal [Matrix](https://matrix.org/) chat client, focused on performance, offline functionality, and broad browser support. +## Goals + +Hydrogen's goals are: + - Work well on desktop as well as mobile browsers + - UI components can be easily used in isolation + - 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. @@ -14,4 +22,4 @@ If you find this interesting, feel free to reach me at `@bwindels:matrix.org`. # How to use -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`. +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`. diff --git a/TODO.md b/TODO.md new file mode 100644 index 00000000..1a693eb2 --- /dev/null +++ b/TODO.md @@ -0,0 +1,13 @@ + - make it a copy, not a fork of brawl, so we can have issues + - add compilation step for ie11 compatible bundle + - compile to es5 + - use bluebird for promises + - make xhr request impl + - once app is loading, go over errors + + + - project goals + - works on mobile + - works well offline + - components can be used in isolation + - lazyload components? \ No newline at end of file