From e49950819f8d27cdd923ba0ef30ffd55220f1443 Mon Sep 17 00:00:00 2001 From: Ruben Verborgh Date: Thu, 3 Sep 2020 10:47:22 +0200 Subject: [PATCH 1/2] 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 9e693958ff..9c5fe5b03c 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 From f9a4dc7e1ce08f1fc5370057fb2acdcacf710f29 Mon Sep 17 00:00:00 2001 From: Ruben Verborgh Date: Thu, 3 Sep 2020 10:55:23 +0200 Subject: [PATCH 2/2] docs: Add badges --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9c5fe5b03c..09b80dcb37 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ # Community Solid Server +[![Build Status](https://travis-ci.com/solid/community-server.svg?branch=master)](https://travis-ci.com/solid/community-server) +[![Coverage Status](https://coveralls.io/repos/github/solid/community-server/badge.svg)](https://coveralls.io/github/solid/community-server) +[![npm version](https://img.shields.io/npm/v/@solid/community-server)](https://www.npmjs.com/package/@solid/community-server) -An open and modular implementation of the [Solid specifications](https://solid.github.io/specification/) +**An open and modular implementation of the [Solid specifications](https://solid.github.io/specification/)** - Community Solid Server is open software -to provide people with their own data pod. +to provide people with their own [Solid](https://solidproject.org/) Pod. - It will give developers an environment to create and test new Solid applications. @@ -19,6 +22,9 @@ 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. +
+The [architectural diagram](https://github.com/RubenVerborgh/solid-server-architecture) +can help you find your way. ## Running locally