Improve README

This commit is contained in:
Midgard 2021-09-15 14:37:55 +02:00
parent 4322f824ff
commit 5acd0a6760
Signed by: midgard
GPG Key ID: 511C112F1331BBB4
1 changed files with 8 additions and 0 deletions

View File

@ -1,5 +1,13 @@
# ![](./assets/feathermost.svg) Feathermost
Before you can use Feathermost, the admin of your Mattermost servers must set up CORS
appropriately. If this is not possible, you can use a CORS puncturing proxy, such as the mitmproxy
setup provided for development (see below).
## Development
Dependencies: none.
To run in development mode, execute ``.
This will start a web server, and mitmproxy to avoid CORS problems.
Dependencies for that: Bash, Python and [`mitmproxy`](