summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorFrédéric Guillot <fred@kanboard.net>2014-08-15 21:13:37 -0700
committerFrédéric Guillot <fred@kanboard.net>2014-08-15 21:13:37 -0700
commit498408d5075cf0060e0f53e58261e6537e0f6080 (patch)
tree46f187f95dfe70a54d601406c5eb68f94979960a /README.markdown
parent9eeded33f68872515954a2fc177fcb47a9273ae9 (diff)
Update documentation
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown81
1 files changed, 42 insertions, 39 deletions
diff --git a/README.markdown b/README.markdown
index 404ae933..32841b69 100644
--- a/README.markdown
+++ b/README.markdown
@@ -21,11 +21,13 @@ Features
- Multiple boards/projects
- Boards customization, rename/add/remove columns
-- Tasks with different colors, categories, sub-tasks, attachments, Markdown support for the description
+- Tasks with different colors, categories, sub-tasks, attachments, comments and Markdown support for the description
- Automatic actions based on events
- Users management with a basic privileges separation (administrator or regular user)
-- External authentication: Google and GitHub accounts as well as LDAP/ActiveDirectory
+- Email notifications
+- External authentication: Google, GitHub, LDAP/ActiveDirectory and Reverse-Proxy
- Webhooks to create tasks from an external software
+- A basic command line interface
- Host anywhere (shared hosting, VPS, Raspberry Pi or localhost)
- No external dependencies
- **Super easy setup**, copy and paste files and you are done!
@@ -41,43 +43,6 @@ License
GNU Affero General Public License version 3: <http://www.gnu.org/licenses/agpl-3.0.txt>
-Authors
--------
-
-Original author: [Frédéric Guillot](http://fredericguillot.com/)
-
-Contributors:
-
-- Alex Butum: https://github.com/dZkF9RWJT6wN8ux
-- Claudio Lobo
-- Cmer: https://github.com/chncsu
-- Floaltvater: https://github.com/floaltvater
-- Gavlepeter: https://github.com/gavlepeter
-- Janne Mäntyharju: https://github.com/JanneMantyharju
-- Jesusaplsoft: https://github.com/jesusaplsoft
-- Kiswa: https://github.com/kiswa
-- Kralo: https://github.com/kralo
-- Levlaz: https://github.com/levlaz
-- Mathgl67: https://github.com/mathgl67
-- Matthieu Keller: https://github.com/maggick
-- Maxime: https://github.com/EpocDotFr
-- Moraxy: https://github.com/moraxy
-- Nala Ginrut: https://github.com/NalaGinrut
-- Nekohayo: https://github.com/nekohayo
-- Olivier Maridat: https://github.com/oliviermaridat
-- Poikilotherm: https://github.com/poikilotherm
-- Rafaelrossa: https://github.com/rafaelrossa
-- Raphaël Doursenaud: https://github.com/rdoursenaud
-- Rzeka: https://github.com/rzeka
-- Sebastien pacilly: https://github.com/spacilly
-- Sylvain Veyrié: https://github.com/turb
-- Toomyem: https://github.com/Toomyem
-- Troloo: https://github.com/troloo
-- Typz: https://github.com/Typz
-- Ybarc: https://github.com/ybarc
-
-There is also many people who have reported bugs or proposed awesome ideas.
-
Documentation
-------------
@@ -114,6 +79,7 @@ Documentation
#### Developers and sysadmins
+- [Email configuration](docs/email-configuration.markdown)
- [Command line interface](docs/cli.markdown)
- [Json-RPC API](docs/api-json-rpc.markdown)
- [Webhooks](docs/webhooks.markdown)
@@ -126,3 +92,40 @@ FAQ
---
Go to the official website: <http://kanboard.net/faq>
+
+Authors
+-------
+
+Original author: [Frédéric Guillot](http://fredericguillot.com/)
+
+Contributors:
+
+- Alex Butum: https://github.com/dZkF9RWJT6wN8ux
+- Claudio Lobo
+- Cmer: https://github.com/chncsu
+- Floaltvater: https://github.com/floaltvater
+- Gavlepeter: https://github.com/gavlepeter
+- Janne Mäntyharju: https://github.com/JanneMantyharju
+- Jesusaplsoft: https://github.com/jesusaplsoft
+- Kiswa: https://github.com/kiswa
+- Kralo: https://github.com/kralo
+- Levlaz: https://github.com/levlaz
+- Mathgl67: https://github.com/mathgl67
+- Matthieu Keller: https://github.com/maggick
+- Maxime: https://github.com/EpocDotFr
+- Moraxy: https://github.com/moraxy
+- Nala Ginrut: https://github.com/NalaGinrut
+- Nekohayo: https://github.com/nekohayo
+- Olivier Maridat: https://github.com/oliviermaridat
+- Poikilotherm: https://github.com/poikilotherm
+- Rafaelrossa: https://github.com/rafaelrossa
+- Raphaël Doursenaud: https://github.com/rdoursenaud
+- Rzeka: https://github.com/rzeka
+- Sebastien pacilly: https://github.com/spacilly
+- Sylvain Veyrié: https://github.com/turb
+- Toomyem: https://github.com/Toomyem
+- Troloo: https://github.com/troloo
+- Typz: https://github.com/Typz
+- Ybarc: https://github.com/ybarc
+
+There is also many people who have reported bugs or proposed awesome ideas.