2021-03-16 16:52:19 +00:00
2021-03-16 16:57:01 +00:00
< img style = "display: flex; margin: 0 auto" alt = "hole chat logo" src = "./public/logo.png" width = "508" >
2021-03-16 16:52:19 +00:00
2021-04-25 16:21:51 +00:00
# Hole chat 🐇
2021-03-16 16:57:01 +00:00
A decentralized chat over [Freenet ](https://freenetproject.org ).
[See docs ](https://docs.hole.horhik.xyz )
2021-04-22 09:47:41 +00:00
2021-04-25 16:21:51 +00:00
## Requirements❗❗❗
2021-04-22 09:47:41 +00:00
[Freenet ](https://freenetproject.org ) running
2021-04-25 16:21:51 +00:00
# Installing 🚀
2021-04-22 09:47:41 +00:00
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 ))
2021-04-25 16:25:16 +00:00
----
## 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.**
2021-04-26 09:32:05 +00:00
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...
2021-04-25 16:25:16 +00:00
----
2021-04-25 16:21:51 +00:00
# TODO ☑️
- [x] Basic sending and receiving messages 💌
- [ ] Add RSA or NTRU encryption 🔐
- [ ] Write tests 🧪
- [ ] Make more vebose documentation 📚
- [ ] Create a hole-daemon 🖥
