Repository navigation
Update README to match organization template - #177
Merged
Merged
Conversation
- Fix tagline casing (TypeScript) and add docs link - Reorder sections: Installation before Development - Rename Workspace to Development, Quick Example to Usage - Rewrite Features in 'Bold. Sentence.' voice with no em-dashes - Add release-status line based on package version 0.6.0 - Add coverage target note (100% is target, not enforced) - Add Security section with private key/agent wallet warning - Add License section with linked MIT license - Keep flat-square badges and all existing links - Maintain Bun commands and docs port 3901 Co-authored-by: Joe Blau <[email protected]>
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.
Summary
This PR updates the root README.md to match the organization's README template (from bloxwap/.github PR #5), using the sfx repository README as a reference for section order and voice.
Changes Made
Structure & Sections
Content Updates
Build Verification
All builds passed successfully:
Main Build
Docs Build
Both the SDK build and documentation build completed successfully with no errors.