Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md to describe Atree #332

Merged
merged 2 commits into from
Aug 10, 2023
Merged

Update README.md to describe Atree #332

merged 2 commits into from
Aug 10, 2023

Conversation

fxamacker
Copy link
Member

@fxamacker fxamacker commented Aug 4, 2023 •
edited
Loading

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 #332 (review) 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 👍

  • Targeted PR against main branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work
  • Code follows the standards mentioned here
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

@fxamacker
Update README.md
321eef2 
Add second sentence that Atree segments, encodes, and stores data into relatively small payloads.

Using "payloads" matches terminology used in forum post about Atree by Jan Bernatik.
@fxamacker fxamacker added the documentation Improvements or additions to documentation label Aug 4, 2023
@fxamacker fxamacker self-assigned this Aug 4, 2023
turbolent
turbolent approved these changes Aug 8, 2023
View reviewed changes
Copy link
Member

@turbolent turbolent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Good idea to mention this very high-level idea in the intro 👍

README.md Outdated Show resolved Hide resolved
@fxamacker
Update first paragraph of README.md
d704b6d 
Update first paragraph to have what, how, why:
__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.

Blockchain is mentioned in 3rd sentence which flows nicely with first sentence of next paragraph introducing Cadence & Flow.
@fxamacker fxamacker merged commit 0c0fa6a into main Aug 10, 2023
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@turbolent turbolent turbolent approved these changes

@ramtinms ramtinms Awaiting requested review from ramtinms

Assignees

@fxamacker fxamacker

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@fxamacker @turbolent