From 6df0b4809b320a1c72c74198cbdc415e31db78c9 Mon Sep 17 00:00:00 2001 From: Curtis Date: Fri, 1 May 2020 20:12:02 +0000 Subject: [PATCH] Add Contributing and Customization sections to readme.md --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 300022678..6f1805ac2 100644 --- a/README.md +++ b/README.md @@ -193,6 +193,26 @@ NODE_ENV=development - `yarn test:jest` - Frontend unit tests. +# Contributing + +We welcome contributions to this project. To contribute, first review the [Contributing doc](docs/contributing.md) + +Additional supporting documents include: +* [Soapbox History](docs/history.md) +* [Redux Store Map](docs/history.md) + +# Customization + +Soapbox supports customization of the user interface, to allow per instance branding and other features. Current customization features include: +* Instance name +* Site logo +* Favicon +* About page +* Terms of Service page +* Promo panel list items, e.g. blog site link + +Customization details can be found in the [Customization doc](docs/customization.md) + # License soapbox-fe is free software: you can redistribute it and/or modify