Add Contributing and Customization sections to readme.md
This commit is contained in:
parent
e36d74e4e8
commit
6df0b4809b
20
README.md
20
README.md
|
@ -193,6 +193,26 @@ NODE_ENV=development
|
||||||
|
|
||||||
- `yarn test:jest` - Frontend unit tests.
|
- `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
|
# License
|
||||||
|
|
||||||
soapbox-fe is free software: you can redistribute it and/or modify
|
soapbox-fe is free software: you can redistribute it and/or modify
|
||||||
|
|
Loading…
Reference in New Issue