diff --git a/README.md b/README.md index 1ba451c..eb28292 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,27 @@ -# webapp -Web application for Kevachat +# Web Application for KevaChat + +KevaChat - is platform for open, uncensored and privacy respectable communication with permanent database stored in blockchain. + +Instance require connection to the [Kevacoin](https://github.com/kevacoin-project/) server, `memcached` and `php`. + +## Model + +KevaChat following open wallet model, where community boost the ballance for talks. + +Administrators have flexible settings of access levels explained in the `.env` file: read-only rooms, connection and post limits, etc. + +## Communication + +Everyone able to join the chat, post messages as ghosty or sign ownership by IP. Also users can explore remote rooms by namespaces if option enabled. + +Basic social features like identicons, replies, mentions, RSS subscriptions etc are supported. + +## Protocol + +KevaChat protocol following native Kevacoin's `key`/`value` model, where `key` - is the `timestamp@username` and `value` - is message. + +All messages related to their room `namespaces`. + +## Contribution + +Project created from people for people, feel free to use it for your own needs, join the development or make your feedback! \ No newline at end of file