commit
9084dcd536
2 changed files with 22 additions and 1 deletions
10
README.md
10
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`.
|
||||
|
|
13
TODO.md
Normal file
13
TODO.md
Normal file
|
@ -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?
|
Reference in a new issue