updated readme

This commit is contained in:
Synox 2016-12-19 22:34:36 +01:00
parent ed6a598209
commit bfc5b76c71

View file

@ -14,7 +14,7 @@
## You have to know
* You should sign up for the chat and you will be notified about issues and bugfixes: [![Join the chat at https://gitter.im/synox/disposable-mailbox](https://badges.gitter.im/synox/disposable-mailbox.svg)](https://gitter.im/synox/disposable-mailbox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
* Use [![Join the chat at https://gitter.im/synox/disposable-mailbox](https://badges.gitter.im/synox/disposable-mailbox.svg)](https://gitter.im/synox/disposable-mailbox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) and you will be be notified about issues and bugfixes.
* This is **WORK IN PROGRESS (WIP)** software, do not use it in production yet! [There are still unsolved problems](https://github.com/synox/disposable-mailbox/issues). Contributions are welcome!
* Licence: <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">disposable-mailbox</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="https://github.com/synox/disposable-mailbox" property="cc:attributionName" rel="cc:attributionURL">github:synox</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
@ -23,7 +23,7 @@
* php >=5.3.0
* [imap extension](http://php.net/manual/book.imap.php)
* apache 2 (but should work on any webserver)
* apache 2 (let me know how it works on nginx!)
## Installation
@ -31,10 +31,10 @@
<?php print imap_base64("SU1BUCBleHRlbnNpb24gc2VlbXMgdG8gYmUgaW5zdGFsbGVkLiA="); ?>
2. clone or download this repository
2. download a [release](https://github.com/synox/disposable-mailbox/releases) or clone this repository
3. copy the `src` directory to your web server.
4. rename `config.sample.php` to `config.php` and apply the imap settings. Move `config.php` to a safe location outside the `public_html`.
5. open `backend.php` and set the new path to `config.php`.
5. edit `backend.php` and set the new path to `config.php`.
## Build it yourself