From 7c757926222a0c681e4b55b1798f6ec5e40a76e7 Mon Sep 17 00:00:00 2001 From: Adhityaa Date: Thu, 7 Jun 2018 13:42:29 +0530 Subject: [PATCH] README: add file Lots of broken links, I'll fix these later. --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..103805c --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +

+ +

+ +

An open source, privacy focused discussion platform.

+ +

+ + + +

+ +

+ +Commento is a discussion platform that you can self-host. You can embed it on your blog, news articles, and any place where you want your readers to add comments. Unlike most alternatives, Commento is lightweight and privacy focused; we'll never sell your data, show ads, embed third-party tracking scripts, or inject affiliate links. + +### Features + + - Privacy focused + - Modern interface with a clean design + - Automatic spam filtering + - Review and approve or delete comments through the moderation interface + - Extremely lightweight, allowing for faster pageloads + - Import from existing services (like Disqus) + - Completely free and open source (MIT Expat license) + +### Editions + +There are three editions of Commento. + + - **Commento Community Edition (CE)** is open source software that's freely available under the MIT Expat license. + - **Commento Enterprise Edition (EE)** includes extra features geared towards organizations. If you're interested in this, [contact me](mailto:c.adhityaa@gmail.com). + - [**Commento Hosted**](https://commento.io) is a hosted version of Commento if you don't want to host and manage servers on your own. This is currently in private beta and you can [add yourself to the waiting list here](https://commento.io). + +### Installation + +The recommended way to install Commento is with [Docker Compose](https://docs.docker.com/compose). Docker Compose allows you to install and manage the service painlessly. [Read our documentation](https://docs.commento.io/installation/docker-compose/) to find our more on how to get Commento running with Docker Compose. + +There are other options to install Commento, including running the binary directly and compiling from source. Please refer to the [installation page](https://docs.commento.io/installation/) for more information. + +Once you've installed the software, you need to configure it with various environment variables before starting the service. To learn more about this, refer to our documentation on [configuring Commento](https://docs.commento.io/configuration/). + +### Contributing + +Commento is possible only because of its community. If this is your first contribution to Commento, please go through the [development documentation](https://docs.commento.io/development/) before you begin. + +Help will always be given at Commento to those who ask for it. We use IRC for chat to collaborate with other developers. You're invited to [hang out with us](https://irc.commento.io) in the `#commento-dev` channel on freenode if you want to contribute to Commento! + +### License + +``` +Copyright 2018 Commento, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +```