29 lines
1.1 KiB
Markdown
29 lines
1.1 KiB
Markdown
|
|
<img style="display: flex; margin: 0 auto" alt="hole chat logo" src="./public/logo.png" width="508">
|
|
|
|
# Hole chat 🐇
|
|
A decentralized chat over [Freenet](https://freenetproject.org).
|
|
|
|
[See docs](https://docs.hole.horhik.xyz)
|
|
|
|
## Requirements❗❗❗
|
|
[Freenet](https://freenetproject.org) running
|
|
|
|
# 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 🖥
|