docs: Add warning

create-reload-action
Lukasz Janyst 4 years ago
parent 2255ece00c
commit fb5f25e45b
No known key found for this signature in database
GPG Key ID: 32DE641041F17A9A
  1. 7
      README.md

@ -2,6 +2,10 @@
peroxide
========
**Warning**: This software has not been thoroughly reviewed for security.
You should only use it if you know what you're doing. I strongly advise against
running it on the open Internet.
Peroxide is a fork of the [ProtonMail bridge][1]. Its goal is to be much like
[Hydroxide][2] except with as much re-use of the upstream code as possible. The
re-use ensures that the upstream changes to the service APIs can be merged in as
@ -32,9 +36,6 @@ To that end, Peroxide:
Server setup
------------
**Note:** This software has not been thoroughly reviewed for security.
Therefore, I strongly advise against running it on the open Internet - run it
locally or use a trusted VPN.
Run the `install.sh` script to install peroxide in your system.

Loading…
Cancel
Save