readme cleanup - #8
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates project documentation to reflect the current public API and the expanded set of supported GRC-20 value types.
Changes:
- Update README examples to use current TypeScript builder method names (
setName,addAuthor) and operation creation patterns (addOpforcreateValueRef). - Refresh documented value types to 13 total, including
RECT, updatedPOINTshape, and updatedEMBEDDINGrepresentation. - Minor cleanup/removal of outdated README snippets in language-specific docs.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| typescript/readme.md | Updates TS usage examples and value type table (adds RECT, updates POINT/EMBEDDING, fixes unset/value-ref examples). |
| rust/README.md | Updates Rust docs for 13 data types and RECT, but introduces an invalid Genesis type example (types::image()). |
| readme.md | Updates top-level README to 13 data types and modern TS builder API usage; adds RECT and updates temporal/schedule descriptions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.