hydrogen-web/README.md

# 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. Bug reports are welcome, but please don't file any feature requests or other missing things to be on par with Element Web.

## 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

If you find this interesting, come and discuss on [`#hydrogen:matrix.org`](https://matrix.to/#/#hydrogen:matrix.org).

# How to use

Hydrogen is deployed to [hydrogen.element.io](https://hydrogen.element.io). You can run it locally `yarn install` (only the first time) and `yarn start` in the terminal, and point your browser to `http://localhost:3000`. If you prefer, you can also [use docker](doc/docker.md).

Hydrogen uses symbolic links in the codebase, so if you are on Windows, have a look at [making git & symlinks work](https://github.com/git-for-windows/git/wiki/Symbolic-Links) there.

# FAQ

Some frequently asked questions are answered [here](doc/FAQ.md).
Update README.md rename to hydrogen 2020-08-04 20:26:19 +05:30			`# Hydrogen`
update README 2019-09-08 14:22:06 +05:30
Update README.md 2020-09-29 20:51:01 +05:30			`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.`
Create README.md 2019-01-09 15:40:33 +05:30
WIP 2020-08-05 22:47:35 +05:30			`## 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`

Add Hyperlink matrix.to to room 2020-12-05 14:46:37 +05:30			If you find this interesting, come and discuss on [`#hydrogen:matrix.org`](https://matrix.to/#/#hydrogen:matrix.org).
add usage instructions 2019-09-08 15:24:18 +05:30
			`# How to use`

docker instructions 2021-02-08 17:13:53 +05:30			Hydrogen is deployed to [hydrogen.element.io](https://hydrogen.element.io). You can run it locally `yarn install` (only the first time) and `yarn start` in the terminal, and point your browser to `http://localhost:3000`. If you prefer, you can also [use docker](doc/docker.md).
add FAQ 2021-01-25 15:05:13 +05:30
Update README.md Co-authored-by: Bruno Windels <bruno@windels.cloud> 2021-04-28 15:53:37 +05:30			`Hydrogen uses symbolic links in the codebase, so if you are on Windows, have a look at [making git & symlinks work](https://github.com/git-for-windows/git/wiki/Symbolic-Links) there.`
update readme 2021-03-26 22:52:17 +05:30
add FAQ 2021-01-25 15:05:13 +05:30			`# FAQ`

Fix typo 2021-02-08 18:51:13 +05:30			`Some frequently asked questions are answered [here](doc/FAQ.md).`