From 1f4d56b645c5483a2e22bcc4d912554f921b954f Mon Sep 17 00:00:00 2001 From: 0xroy Date: Sun, 24 Nov 2024 18:24:38 -0800 Subject: [PATCH] Update README (#286) * Updated README * Edited README --- README.md | 39 ++++++++++++++++++--------------------- 1 file changed, 18 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 2d724f9..cddfda5 100644 --- a/README.md +++ b/README.md @@ -2,34 +2,31 @@ ## Overview -0G Storage is the storage layer for the ZeroGravity data availability (DA) system. The 0G Storage layer holds three important features: +0G Storage is a decentralized data storage system designed to address the challenges of high-throughput and low-latency data storage and retrieval, particularly for areas such as AI. -* Built-in - It is natively built into the ZeroGravity DA system for data storage and retrieval. -* General purpose - It is designed to support atomic transactions, mutable kv stores as well as archive log systems to enable wide range of applications with various data types. -* Incentive - Instead of being just a decentralized database, 0G Storage introduces PoRA mining algorithm to incentivize storage network participants. +## System Architecture -To dive deep into the technical details, continue reading [0G Storage Spec.](docs/) +0G Storage consists of two main components: -## Integration +1. **Data Publishing Lane**: Ensures fast Merkle treedata root commitment and verification through 0G Chain. +2. **Data Storage Lane**: Manages large data transfers and storage using an erasure-coding mechanism for redundancy and sharding for parallel processing. -We provide a [SDK](https://github.com/0glabs/0g-js-storage-sdk) for users to easily integrate 0G Storage in their applications with the following features: +Across the two lanes, 0G Storage supports the following features: -* File Merkle Tree Class -* Flow Contract Types -* RPC methods support -* File upload -* Support browser environment -* Tests for different environments (In Progress) -* File download (In Progress) +* **General Purpose Design**: Supports atomic transactions, mutable key-value stores, and archive log systems, enabling a wide range of applications with various data types. +* **Validated Incentivization**: Utilizes the PoRA (Proof of Random Access) mining algorithm to mitigate data outsourcing issue and to ensure rewards are distributed to nodes who contribute to the storage network. -## Deployment +For in-depth technical details about 0G Storage, please read our [Intro to 0G Storage](https://docs.0g.ai/og-storage). -Please refer to [Deployment](docs/run.md) page for detailed steps to compile and start a 0G Storage node. +## Documentation -## Test +- If you want to run a node, please refer to the [Running a Node](https://docs.0g.ai/run-a-node/storage-node) guide. +- If you want to conduct local testing, please refer to [Onebox Testing](https://github.com/0glabs/0g-storage-node/blob/main/docs/onebox-test.md) guide. +- If you want build a project using 0G storage, please refer to the [0G Storage SDK](https://docs.0g.ai/build-with-0g/storage-sdk) guide. -Please refer to the [One Box Test](docs/onebox-test.md) page for local testing purpose. +## Support and Additional Resources +We want to do everything we can to help you be successful while working on your contribution and projects. Here you'll find various resources and communities that may help you complete a project or contribute to 0G. -## Contributing - -To make contributions to the project, please follow the guidelines [here](contributing.md). +### Communities +- [0G Telegram](https://t.me/web3_0glabs) +- [0G Discord](https://discord.com/invite/0glabs)