diff --git a/README.md b/README.md index 161377a..cbec78b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,69 @@ -# Influence (Android) -This is decentralized messenger, which work on top of Kademlia DHT. Breaks NAT with uPnP, or relay peer. DHT implementation is Kademlia-like: https://github.com/tomp2p/TomP2P +
+
+ This is a decentralized messenger for Android, which work on top of TomP2P DHT. +
+ + + + + +## Table of Contents + +- [Intro](#intro) +- [Getting started](#getting-started) +- [Features](#features) +- [Useful links](#useful-links) +- [License](#license) +- [Author](#author) + +## Intro +*[Soon]* + + +## Getting started +1. Clone repo: +```bash +$ git clone https://github.com/ChronosX88/Influence-android +$ cd Influence-android +``` +2. Simply open project in Android Studio. + +(Also exists precompiled APKs - see Releases) + +[⇧ back to top](#contents) + +## Features +- 1:1 chats +- Decentralized message storage +- Username system +- Group chats [Soon] +- Encryption [Soon] +- Channels (like Telegram) [Soon] +- Profile pictures [Soon] + +[⇧ back to top](#contents) + +## Useful links + +- [TomP2P GitHub](https://github.com/tomp2p/TomP2P) + +[⇧ back to top](#contents) + +## License + +This project is licensed under the GNU GPLv3 License - see the [LICENSE](LICENSE) file for details. + +[⇧ back to top](#contents) + +## Author + +```txt +Author : ChronosX88 +Email : chronosx88@gmail.com +Github : https://github.com/ChronosX88/Influence-android.git +``` + +[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com) + +[⇧ back to top](#contents)