aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhozan23 <hozan23@karyontech.net>2024-06-12 15:16:47 +0200
committerhozan23 <hozan23@karyontech.net>2024-06-12 15:16:47 +0200
commitd6a280f69a6685d5b4da5366626fb76a27f0cc07 (patch)
tree05d62e114276039939b641fd50bbe97cfb854c27
parent36eae63e84f22c9973edee699d3388ee2674874e (diff)
update README.md
-rw-r--r--Cargo.toml2
-rw-r--r--README.md26
-rw-r--r--p2p/README.md2
3 files changed, 15 insertions, 15 deletions
diff --git a/Cargo.toml b/Cargo.toml
index 881c366..a74b9a3 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -5,7 +5,7 @@ resolver = "2"
members = ["core", "net", "p2p", "jsonrpc"]
[workspace.package]
-description = "An infrastructure for peer-to-peer, decentralized, and collaborative software."
+description = "A library for building p2p, decentralized, and collaborative software"
version = "0.1.1"
edition = "2021"
homepage = "https://karyontech.net"
diff --git a/README.md b/README.md
index c179efc..6f310a0 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Karyon
- An infrastructure for peer-to-peer, decentralized, and collaborative software
+A library for building p2p, decentralized, and collaborative software
[Website](https://karyontech.net/) | [Discord](https://discord.gg/xuXRcrkz3p) | [irc](https://libera.chat/) #karyon on liberachat
@@ -9,18 +9,18 @@
## Overview
-Many developers around the world aspire to build peer-to-peer, decentralized
-apps that are resilient, secure, and free from central control.
-However, there are still not many libraries and tools available to build these
-kinds of apps. This forces many developers to either abandon their ideas or
-develop a new p2p network stack and tools from scratch. Such efforts are not
-only time-consuming but also prone to errors and security vulnerabilities, as
-each new implementation reintroduces potential weaknesses.
-
-Karyon provides developers with the components and tools needed to create p2p
-and decentralized apps and simplifies the complexities associated with building
-them. Its primary goal is to make decentralization more accessible and
-efficient for developers everywhere.
+Building peer-to-peer (p2p), decentralized applications that are resilient,
+secure, and free from central control is a challenge for developers. There are
+not many libraries and tools available to build these applications. As
+a result, many developers either abandon their ideas or have to develop a new
+p2p network stack and tools from scratch. Instead of sharing common components
+and tools for building p2p systems, every p2p project seems to reinvent the
+wheel, which increases the effort required and the potential for vulnerabilities.
+
+Karyon addresses this issue by providing developers with the components and
+tools needed to create p2p and decentralized apps, simplifying the complexities
+associated with building them. its primary goal is to make decentralization
+more accessible and efficient for developers everywhere.
## Crates
diff --git a/p2p/README.md b/p2p/README.md
index 02c4742..a0303bb 100644
--- a/p2p/README.md
+++ b/p2p/README.md
@@ -31,7 +31,7 @@ differences and optimizations. Some of the main changes:
> Despite criticisms of Kademlia's vulnerabilities, particularly concerning
> Sybil and Eclipse attacks [[1]](https://eprint.iacr.org/2018/236.pdf)
> [[2]](https://arxiv.org/abs/1908.10141), we chose to use Kademlia because our
-> main goal is to build an infrastructure focused on sharing data. This choice
+> main goal is to build a network focused on sharing data. This choice
> may also assist us in supporting sharding in the future. However, we have made
> efforts to mitigate most of its vulnerabilities. Several projects, including
> BitTorrent, Ethereum, IPFS, and Storj, still rely on Kademlia.