From ec04a32c15d43545882668cddd1be2393100c197 Mon Sep 17 00:00:00 2001 From: hozan23 Date: Mon, 20 Nov 2023 13:46:48 +0300 Subject: update README.md --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bd304be..41929e9 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,19 @@ # karyons -> **This Project is a Work in Progress** - An infrastructure for peer-to-peer, decentralized, and collaborative software. +> In molecular biology, a Karyon is essentially "a part of the cell +> containing DNA and RNA and responsible for growth and reproduction" + Join us on: - [Discord](https://discord.gg/xuXRcrkz3p) ## Crates -- [karyons core](./core): Provides essential utilities and core functionality for karyons. -- [karyons net](./net): Provides network types and functionality for karyons. +- [karyons core](./core): Essential utilities and core functionality. +- [karyons net](./net): Provides a network interface for TCP, UDP, and Unix, + along with common network functionality. - [karyons p2p](./p2p): A lightweight, extensible, and customizable peer-to-peer (p2p) network stack. - [karyons jsonrpc](./jsonrpc): A fast and lightweight async @@ -20,6 +22,13 @@ Join us on: implementation for building collaborative software. - karyons base: A lightweight, extensible database that operates with karyons crdt. +## Status + +This project is a work in progress. The current focus is on shipping karyons +crdt and karyons store, along with major changes to the network stack, +including TLS implementation. You can check the issues for updates on ongoing +tasks. + ## Contribution Feel free to open a pull request or an issue. @@ -30,4 +39,3 @@ All the code in this repository is licensed under the GNU General Public License, version 3 (GPL-3.0). You can find a copy of the license in the [LICENSE](./LICENSE) file. - -- cgit v1.2.3