diff --git a/README.md b/README.md index a8752ee..cd75295 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,28 @@ hole chat logo -# Hole chat +# Hole chat πŸ‡ A decentralized chat over [Freenet](https://freenetproject.org). [See docs](https://docs.hole.horhik.xyz) -## Requirements +## Requirements❗❗❗ [Freenet](https://freenetproject.org) running -# Installing +# Installing πŸš€ 1. Clone [this](https://github.com/hole-chat/core) repo 2. Launch core (`cargo run`) 3. Install and launch client (for example [rabbit-hole](https://github.com/hole-chat/rabbit-hole)) +---- +## About frontend clients πŸ–ŒοΈ +The purpose of "hole project" is to write independend frontend clients for each platform, because, **app cannot be good for one particular platform if it's multiplatform.** +As a hole-core is just a logic part, which should be multiplatform, **frontend shouldn't**, And I encourage you to help and write "rabbit-hole for android" or "rabbit-hole-gtk", etc... + +---- + +# TODO β˜‘οΈ +- [x] Basic sending and receiving messages πŸ’Œ +- [ ] Add RSA or NTRU encryption πŸ” +- [ ] Write tests πŸ§ͺ +- [ ] Make more vebose documentation πŸ“š +- [ ] Create a hole-daemon πŸ–₯