summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTimo <timo@koesters.xyz>2020-08-12 21:17:53 +0200
committerTimo <timo@koesters.xyz>2020-08-12 21:17:53 +0200
commit2fc99c05e1ebff3c9955b1930b0896d660e5a230 (patch)
tree2d054cf5485b093ff5b4fd23d25d17df06b5b4f8 /README.md
parent87ed132ae4d23724818b4f3ee967a1ed24220a92 (diff)
downloadconduit-2fc99c05e1ebff3c9955b1930b0896d660e5a230.zip
docs: add documentation to the repo and improve layout
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/README.md b/README.md
index 4c84040..ad13089 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
[![Liberapay](https://img.shields.io/liberapay/receives/timokoesters?logo=liberapay)](https://liberapay.com/timokoesters)
[![Matrix](https://img.shields.io/matrix/conduit:koesters.xyz?server_fqdn=matrix.koesters.xyz&logo=matrix)](https://matrix.to/#/#conduit:koesters.xyz)
-#### What is the goal
+#### What is the goal?
A fast Matrix homeserver that's easy to set up and just works. You can install it on a mini-computer like the Raspberry Pi to host Matrix for your family, friends or company.
@@ -18,11 +18,14 @@ Yes! Just open a Matrix client (<https://app.element.io> or Element Android for
#### How can I deploy my own?
-You just have to clone the repo, build it with `cargo build --release` and call the binary (target/release/conduit) from somewhere like a systemd script.
-It's explained in more detail [here](https://git.koesters.xyz/timo/conduit/wiki/Deploy).
+##### From source
-Or you can just build the docker image and run it with docker or docker-compose.
-It's explained in more details [here](https://git.koesters.xyz/timo/conduit/wiki/Docker) or in the [README](docker/README.md) in the docker folder.
+Clone the repo, build it with `cargo build --release` and call the binary
+(target/release/conduit) from somewhere like a systemd script. [Read more](DEPLOY_FROM_SOURCE.md)
+
+##### Using Docker
+
+Build the docker image and run it with docker or docker-compose. [Read more](docker/README.md)
#### What is it build on?