diff --git a/README.md b/README.md index 5acdfd9..1e5e43b 100644 --- a/README.md +++ b/README.md @@ -159,12 +159,16 @@ If you want to host your own Syng server, you can do that, but you can also use You can install the server via pip: - pip install 'syng[server]' + pip install syng and then run via: syng server +The server is also automatically available if you install the client. + +There exists one optional dependency for the server: `alt-profanity-check`. If this package is installed, each username is checked for profanity, otherwise no such check happens. + ## Docker Alternatively you can run the server using docker. It listens on port 8080 and reads a key file at `/app/keys.txt` when configured as private or restricted.