Hole/core
Hole/core
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
George 2021-04-25 19:21:51 +03:00 committed by GitHub
parent 60f5ed6c6e
commit 7d939d3e95
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,15 +1,22 @@
<img style="display: flex; margin: 0 auto" alt="hole chat logo" src="./public/logo.png" width="508"> <img style="display: flex; margin: 0 auto" alt="hole chat logo" src="./public/logo.png" width="508">
# Hole chat # Hole chat 🐇
A decentralized chat over [Freenet](https://freenetproject.org). A decentralized chat over [Freenet](https://freenetproject.org).
[See docs](https://docs.hole.horhik.xyz) [See docs](https://docs.hole.horhik.xyz)
## Requirements ## Requirements❗❗❗
[Freenet](https://freenetproject.org) running [Freenet](https://freenetproject.org) running
# Installing # Installing 🚀
1. Clone [this](https://github.com/hole-chat/core) repo 1. Clone [this](https://github.com/hole-chat/core) repo
2. Launch core (`cargo run`) 2. Launch core (`cargo run`)
3. Install and launch client (for example [rabbit-hole](https://github.com/hole-chat/rabbit-hole)) 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 🖥