onflow / atree

Atree provides scalable arrays and scalable ordered maps.
https://onflow.org
Apache License 2.0
40 stars 16 forks source link

Update README.md to describe Atree #332

Closed fxamacker closed 1 year ago

fxamacker commented 1 year ago

Description

After first sentence about Atree, add:

It segments, encodes, and stores data into relatively small payloads.

This gives more context before going into technical detail.

Also, using "payloads" here matches terminology used in forum post about Atree by Jan.

UPDATE:

Based on comments/followups at https://github.com/onflow/atree/pull/332#pullrequestreview-1567739548 this is first paragraph:

Atree provides scalable arrays and scalable ordered maps. It segments, encodes, and stores data into relatively small, relatively fixed-size segments of bytes (aka payloads, registers, or slabs). This enables blockchains to only hash and transmit modified segments instead of the entire array, map, or large element.

Thanks @turbolent for feedback and suggestions :+1: