From ed6a598209df032dd3ae57ba109fa361f42d397d Mon Sep 17 00:00:00 2001 From: Synox Date: Mon, 19 Dec 2016 22:21:53 +0100 Subject: [PATCH] updated readme --- readme.md | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/readme.md b/readme.md index d510042..1ff5153 100644 --- a/readme.md +++ b/readme.md @@ -12,15 +12,13 @@ | ------------- | -## Quality/Status: -This is **WORK IN PROGRESS (WIP)** software, do not use it in production yet! It may lose your mails and people may gain access to your mails. There are still unsolved problems. Contributions are welcome! +## 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) +* 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) +* 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: Creative Commons License
disposable-mailbox by github:synox is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. -## Licence -Creative Commons License
disposable-mailbox by github:synox is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. - ## Webserver requirements * php >=5.3.0 @@ -40,17 +38,13 @@ You should sign up for the chat and you will be notified about issues and bugfix ## Build it yourself -The src directory contains all required files. If you want to update the php dependencies, you can update them yourself. You must have [composer](https://getcomposer.org/download/) installed. See also `build.sh`. +The src directory contains all required files. If you want to update the php dependencies, you can update them yourself. You must have [composer](https://getcomposer.org/download/) installed. Install php dependecies: composer install -## TODO - 1. setup a link redirection provider (to keep the existence of your installation secret) - 2. provide error message if config.php is missing or in a public folder. - ## Credit This could not be possible without... @@ -59,4 +53,3 @@ This could not be possible without... * /~https://github.com/barbushin/php-imap * /~https://github.com/gregjacobs/Autolinker.js/ * http://chancejs.com/ - * /~https://github.com/TomFrost/node-phonetic