From cb0476683cbaf323a45c81554b36f3c7750bcbd7 Mon Sep 17 00:00:00 2001 From: Ruben Verborgh Date: Thu, 3 Sep 2020 10:47:22 +0200 Subject: [PATCH] docs: Explain context Closes https://github.com/solid/community-server/issues/29 --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9e693958f..9c5fe5b03 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,24 @@ -# community-server +# Community Solid Server -Implementation of the Solid server. +An open and modular implementation of the [Solid specifications](https://solid.github.io/specification/) -The architecture is based on the description [here](https://github.com/RubenVerborgh/solid-server-architecture). -We follow the Inrupt [coding standards](https://github.com/inrupt/public-documentation/blob/master/coding-conventions/javascript-coding-standards.md) where feasible. -An initial dummy implementation with some examples can be found [here](https://github.com/RubenVerborgh/solid-server-ts). +- Community Solid Server is open software +to provide people with their own data pod. + +- It will give developers an environment +to create and test new Solid applications. + +- Its modular architecture will allows us +to try out new ideas on the server side +and thereby shape the future of Solid. + +## Current status +This software is in **alpha status**, +which means it is **too early for use with Solid apps**. + +However, you can already boot up the server, +play around with it, +and check how it is made. ## Running locally