From 7d939d3e958d253f40c47df0a72d510d6e1f6f8f Mon Sep 17 00:00:00 2001 From: George Date: Sun, 25 Apr 2021 19:21:51 +0300 Subject: [PATCH] Update README.md --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a8752ee..cc576a5 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,22 @@ 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)) + +# TODO β˜‘οΈ +- [x] Basic sending and receiving messages πŸ’Œ +- [ ] Add RSA or NTRU encryption πŸ” +- [ ] Write tests πŸ§ͺ +- [ ] Make more vebose documentation πŸ“š +- [ ] Create a hole-daemon πŸ–₯