From 5acd0a67603d0b7ed20902628da7a8e2a9865d62 Mon Sep 17 00:00:00 2001 From: Midgard Date: Wed, 15 Sep 2021 14:37:55 +0200 Subject: [PATCH] Improve README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index d835372..0541d87 100644 --- a/README.md +++ b/README.md @@ -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 `rundev.sh`. This will start a web server, and mitmproxy to avoid CORS problems. Dependencies for that: Bash, Python and [`mitmproxy`](https://mitmproxy.org/).