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

Merge branch 'master' of github.com:hole-chat/hole

Browse source
This commit is contained in:
Horhik 2021-04-28 00:03:33 +03:00
parent f980d5e08c af36e97db3
commit 2655d8da4b
1 changed files with 16 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,15 +1,28 @@
<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))
----
## 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 🖥