Skip to content

Improve README with fixes and better formatting#1

Draft
krinde wants to merge 1 commit into
masterfrom
improve-readme-documentation
Draft

Improve README with fixes and better formatting#1
krinde wants to merge 1 commit into
masterfrom
improve-readme-documentation

Conversation

@krinde

@krinde krinde commented Jun 24, 2026

Copy link
Copy Markdown
Owner

Summary

This PR improves the README with several fixes and enhancements:

Fixes

  • Fixed typo: "tranforming" → "transforming"
  • Fixed broken console.log(JSON.stringify()) statement to properly output the result

Improvements

  • Added language annotations to code blocks (bash for terminal commands, javascript for code examples)
  • Made "JSON-LD" a link to the official specification at json-ld.org
  • Renamed "How to use" section to "Installation" (more standard convention)
  • Added a dedicated "Usage" section
  • Improved overall clarity and friendlier wording
  • Cleaner code block formatting

Changes

  • Added a proper project description
  • Section headings are now appropriately separated
  • Example section has a descriptive introduction

@krinde can click here to continue refining the PR

- Fix typo: 'tranforming' → 'transforming'
- Add language annotations to code blocks (bash, javascript)
- Link to JSON-LD specification
- Rename section to follow standard conventions
- Fix broken console.log statement in example
- Improve overall clarity and formatting
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants