Skip to content

docs: overhaul README — clear intro + LSP7/LSP8 token sections#279

Merged
frozeman merged 1 commit intolukso-network:mainfrom
emmet-bot:docs/readme-overhaul
Apr 22, 2026
Merged

docs: overhaul README — clear intro + LSP7/LSP8 token sections#279
frozeman merged 1 commit intolukso-network:mainfrom
emmet-bot:docs/readme-overhaul

Conversation

@emmet-bot
Copy link
Copy Markdown
Contributor

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

  • Better intro: Opens with exactly what you can deploy (Universal Profiles, LSP7 tokens, LSP8 NFTs) in plain terms, plus a bullet with what each thing actually is ("smart accounts", "fungible tokens like ERC-20", etc.)
  • Clearer setup: Condensed to a single tight block instead of scattered prose
  • Token sections prominently added:
    • LSP7 Digital Asset (fungible token) with metadata example
    • LSP8 NFT with tokenIdFormat values explained
  • Shorter overall: 119 lines removed, 95 added — net -24 lines, more content per line
  • Node 22+ requirement mentioned up front
  • Removed badge duplication

… 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-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.78%. Comparing base (039583e) to head (9cdf15d).
⚠️ Report is 37 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@frozeman frozeman merged commit 68f026c into lukso-network:main Apr 22, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants