From a6bd89e02a719f73dd0dd424b3b23a3f0691245f Mon Sep 17 00:00:00 2001 From: Matthew Wild Date: Thu, 10 Jun 2021 14:02:41 +0100 Subject: [PATCH] Update README to be more friendly for people first discovering the project --- README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b130a28..6b0db03 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,35 @@ -# Snikket builder +# Snikket server images This is the source repository for building [Snikket service](https://snikket.org/service/) Docker images. -## Requirements +Snikket is an open-source self-hosted personal messaging service. It aims to +provide an alternative to proprietary and centralized messaging platforms +while supporting all the expected features and being easy to use. + +For more information see the [Snikket website](https://snikket.org/). + +## Getting Started with Snikket + +For instructions on getting started with Snikket, see the [Snikket installation +guide](https://snikket.org/service/quickstart/) on our website. + +## Building images + +This section is for people who want to build their own images of Snikket, e.g. +for development purposes. + +### Requirements - GNU make - docker (tested on 19.03.5) - ansible (tested on 2.7 (debian buster)) -## Building +### Building Run `make` -## Running +### Running The easiest way is to use docker-compose. Copy the file `snikket.conf.example` to `snikket.conf` and edit the values in it. Then run: