update README

janeirodigital · Sep 9, 2024 · bc2c64e · bc2c64e
1 parent 633cd9b
commit bc2c64e
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/janeirodigital/sai-js/actions/workflows/ci.yml/badge.svg)](https://github.com/janeirodigital/sai-js/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/janeirodigital/sai-js/branch/main/graph/badge.svg)](https://codecov.io/gh/janeirodigital/sai-js/tree/main)
-[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/solid/data-interoperability-panel)
+[![Matrix chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://app.gitter.im/#/room/#solid_specification:gitter.im)
 [![MIT license](https://img.shields.io/github/license/janeirodigital/sai-js)](https://github.com/janeirodigital/sai-js/blob/main/LICENSE)
 
 Modules implementing [Solid Application Interoperability Specification](https://solid.github.io/data-interoperability-panel/specification/)
@@ -16,10 +16,14 @@ Modules implementing [Solid Application Interoperability Specification](https://
 
 ## Development
 
-### Docker
+### Docker Shared Services
 
 Default setup assumes `docker` command available, and runs it as non-root user.
-It only uses [official redis image](https://hub.docker.com/_/redis) for the authorization agent service.
+Also [mkcert](https://mkcert.dev/) is required.
+
+The setup is using modified `Makefile` and `docker-compose.yaml` from  [docker-shared-services](https://github.com/wayofdev/docker-shared-services)
+
+
 
 ### Node, corepack and pnpm
 
@@ -44,22 +48,25 @@ corepack prepare pnpm@latest --activate
 pnpm install
 pnpm build
 pnpm test
-pnpm dev
 ```
-In separate terminal
+To create local certificates
+```bash
+make cert-install
+```
+To start local development
 
 ```bash
-pnpm watch
+make up
 ```
 
-It will run following:
+It will run the following:
 
 #### Community Solid Server
 
 Run from [packages/css-solid-fixture](https://github.com/janeirodigital/sai-js/tree/main/packages/css-storage-fixture).
 Used for solid storage instances and solid-oidc provider.
 
-Available on http://https://pod.docker, default demo account is `[email protected]` with `password`.
+Available on https://pod.docker, default demo account is `[email protected]` with `password`.
 
 #### Authorization Agent
 
@@ -82,13 +89,13 @@ Dev config uses local CSS as default provider when input left empty.
 
 ## Localization
 
-The translation project for all relevant components is available at https://hosted.weblate.org/projects/sai/
-Courtesy of [Weblate Libre hosting](https://weblate.org/en/hosting/#libre).
+The translation project for all relevant components is hosted thanks to the courtesy of [Weblate Libre hosting](https://weblate.org/en/hosting/#libre).
+
+[<img src="https://hosted.weblate.org/widget/sai/open-graph.png" alt="Translation status" width="40%" />](https://hosted.weblate.org/engage/sai/)
 
 ## Funding
 
 This project is funded through the [NGI Zero Entrust Fund](https://nlnet.nl/entrust), a fund established by [NLnet](https://nlnet.nl) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu) program. Learn more at the [NLnet project page](https://nlnet.nl/project/SolidInterop3).
 
-[<img src="https://nlnet.nl/logo/banner.png" alt="NLnet foundation logo" width="20%" />](https://nlnet.nl)
-
-[<img src="https://nlnet.nl/image/logos/NGI0Entrust_tag.svg" alt="NGI Zero Entrust Logo" width="20%" />](https://nlnet.nl/entrust)
+[<img src="https://nlnet.nl/logo/banner.png" alt="NLnet foundation logo" height="100px" style="margin-right: 50px" />](https://nlnet.nl)
+[<img src="https://nlnet.nl/image/logos/NGI0Entrust_tag.svg" alt="NGI Zero Entrust Logo" height="100px"/>](https://nlnet.nl/entrust)
diff --git a/packages/api-messages/README.md b/packages/api-messages/README.md
@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/janeirodigital/sai-impl-service/actions/workflows/ci.yml/badge.svg)](https://github.com/janeirodigital/sai-impl-service/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/janeirodigital/sai-impl-service/branch/main/graph/badge.svg?flag=api-messages)](https://codecov.io/gh/janeirodigital/sai-impl-service/tree/main/packages/api-messages)
-[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/solid/data-interoperability-panel)
+[![Matrix chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://app.gitter.im/#/room/#solid_specification:gitter.im)
 [![MIT license](https://img.shields.io/github/license/janeirodigital/sai-impl-service)](https://github.com/janeirodigital/sai-impl-service/blob/main/LICENSE)
 
 Interfaces used between the API handler of [SAI Authorization Agent Service](https://github.com/janeirodigital/sai-impl-service/tree/main/packages/service)

diff --git a/packages/application/README.md b/packages/application/README.md
@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/janeirodigital/sai-js/actions/workflows/ci.yml/badge.svg)](https://github.com/janeirodigital/sai-js/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/janeirodigital/sai-js/branch/main/graph/badge.svg?flag=application)](https://codecov.io/gh/janeirodigital/sai-js/tree/codecov/packages/application)
-[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/solid/data-interoperability-panel)
+[![Matrix chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://app.gitter.im/#/room/#solid_specification:gitter.im)
 [![npm version](https://badge.fury.io/js/%40janeirodigital%2Finterop-application.svg)](https://www.npmjs.com/package/@janeirodigital/interop-application)
 [![MIT license](https://img.shields.io/github/license/janeirodigital/sai-js)](https://github.com/janeirodigital/sai-js/blob/main/LICENSE)
 
@@ -13,7 +13,7 @@ this library implements are still a work in progress. While we track changes
 to the public API of this library with semver, the underlying data will be slightly changing
 for the rest of 2021. We are commited to keep this implementation up to date.
 If you plan to use your application in production please ask the specification editors
-on the [public chatroom](https://gitter.im/solid/data-interoperability-panel)
+on the [public chatroom](https://app.gitter.im/#/room/#solid_specification:gitter.im)
 about the stability of the data model.
 
 ## Overview

diff --git a/packages/authorization-agent/README.md b/packages/authorization-agent/README.md
@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/janeirodigital/sai-js/actions/workflows/ci.yml/badge.svg)](https://github.com/janeirodigital/sai-js/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/janeirodigital/sai-js/branch/main/graph/badge.svg?flag=application)](https://codecov.io/gh/janeirodigital/sai-js/tree/codecov/packages/authorization-agent)
-[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/solid/data-interoperability-panel)
+[![Matrix chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://app.gitter.im/#/room/#solid_specification:gitter.im)
 [![npm version](https://badge.fury.io/js/%40janeirodigital%2Finterop-application.svg)](https://www.npmjs.com/package/@janeirodigital/interop-authorization-agent)
 [![MIT license](https://img.shields.io/github/license/janeirodigital/sai-js)](https://github.com/janeirodigital/sai-js/blob/main/LICENSE)
 
@@ -13,7 +13,7 @@ this library implements are still a work in progress. While we track changes
 to the public API of this library with semver, the underlying data will be slightly changing
 for the rest of 2021. We are commited to keep this implementation up to date.
 If you plan to use your application in production please ask the specification editors
-on the [public chatroom](https://gitter.im/solid/data-interoperability-panel)
+on the [public chatroom](https://app.gitter.im/#/room/#solid_specification:gitter.im)
 about the stability of the data model.
 
 ## Service

diff --git a/packages/data-model/README.md b/packages/data-model/README.md
@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/janeirodigital/sai-js/actions/workflows/ci.yml/badge.svg)](https://github.com/janeirodigital/sai-js/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/janeirodigital/sai-js/branch/main/graph/badge.svg?flag=data-model)](https://codecov.io/gh/janeirodigital/sai-js/tree/main/packages/data-model)
-[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/solid/data-interoperability-panel)
+[![Matrix chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://app.gitter.im/#/room/#solid_specification:gitter.im)
 [![npm version](https://badge.fury.io/js/%40janeirodigital%2Finterop-data-model.svg)](https://www.npmjs.com/package/@janeirodigital/interop-data-model)
 [![MIT license](https://img.shields.io/github/license/janeirodigital/sai-js)](https://github.com/janeirodigital/sai-js/blob/main/LICENSE)
 

diff --git a/packages/service/README.md b/packages/service/README.md
@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/janeirodigital/sai-impl-service/actions/workflows/ci.yml/badge.svg)](https://github.com/janeirodigital/sai-impl-service/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/janeirodigital/sai-impl-service/branch/main/graph/badge.svg?flag=service)](https://codecov.io/gh/janeirodigital/sai-impl-service/tree/main/packages/service)
-[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/solid/data-interoperability-panel)
+[![Matrix chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://app.gitter.im/#/room/#solid_specification:gitter.im)
 [![MIT license](https://img.shields.io/github/license/janeirodigital/sai-impl-service)](https://github.com/janeirodigital/sai-impl-service/blob/main/LICENSE)
 
 [Solid Application Interoperability](https://solid.github.io/data-interoperability-panel/specification/) compliant Authorization Agent. It requires a compatible frontend (e.g. [SAI Authorization Agent Web](https://github.com/janeirodigital/sai-impl-web)).

diff --git a/packages/test-utils/README.md b/packages/test-utils/README.md
@@ -2,6 +2,6 @@
 
 [![CI](https://github.com/janeirodigital/sai-js/actions/workflows/ci.yml/badge.svg)](https://github.com/janeirodigital/sai-js/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/janeirodigital/sai-js/branch/main/graph/badge.svg?flag=test-utils)](https://codecov.io/gh/janeirodigital/sai-js/tree/main/packages/test-utils)
-[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/solid/data-interoperability-panel)
+[![Matrix chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://app.gitter.im/#/room/#solid_specification:gitter.im)
 [![npm version](https://badge.fury.io/js/%40janeirodigital%2Finterop-test-utils.svg)](https://www.npmjs.com/package/@janeirodigital/interop-test-utils)
 [![MIT license](https://img.shields.io/github/license/janeirodigital/sai-js)](https://github.com/janeirodigital/sai-js/blob/main/LICENSE)
diff --git a/packages/utils/README.md b/packages/utils/README.md
@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/janeirodigital/sai-js/actions/workflows/ci.yml/badge.svg)](https://github.com/janeirodigital/sai-js/actions/workflows/ci.yml)
 [![codecov](https://codecov.io/gh/janeirodigital/sai-js/branch/main/graph/badge.svg?flag=utils)](https://codecov.io/gh/janeirodigital/sai-js/tree/main/packages/utils)
-[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/solid/data-interoperability-panel)
+[![Matrix chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://app.gitter.im/#/room/#solid_specification:gitter.im)
 [![npm version](https://badge.fury.io/js/%40janeirodigital%2Finterop-utils.svg)](https://www.npmjs.com/package/@janeirodigital/interop-utils)
 [![MIT license](https://img.shields.io/github/license/janeirodigital/sai-js)](https://github.com/janeirodigital/sai-js/blob/main/LICENSE)