docs: overhaul README — clear intro + LSP7/LSP8 token sections#279
Merged
frozeman merged 1 commit intolukso-network:mainfrom Apr 22, 2026
Merged
docs: overhaul README — clear intro + LSP7/LSP8 token sections#279frozeman merged 1 commit intolukso-network:mainfrom
frozeman merged 1 commit intolukso-network:mainfrom
Conversation
… all covered - Lead with a one-sentence value prop (profiles, tokens, NFTs in one call) - Add bullet summary of what can be deployed with plain English descriptions - Note viem + LSP23 usage and Node 22+ requirement up front - Consolidate setup to a single concise block - Add LSP7 and LSP8 deployment sections with metadata examples - Add tokenIdFormat reference (0-4) - Clean up Development section - Remove badge duplication
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #279 +/- ##
===========================================
+ Coverage 18.95% 98.78% +79.82%
===========================================
Files 15 8 -7
Lines 1087 328 -759
Branches 390 42 -348
===========================================
+ Hits 206 324 +118
+ Misses 859 4 -855
+ Partials 22 0 -22 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
frozeman
approved these changes
Apr 22, 2026
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
Complete README overhaul for clarity and user-friendliness. The old README had a weak intro that didn't explain the value, and the Usage section buried the library's token deployment capabilities.
Key Changes