Expand README and npm metadata for discoverability - #197
Merged
Conversation
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.
What changed
description, addedkeywords(react, react-components, component-library, cqrs, event-sourcing, cratis, arc, chronicle, commands, queries, data-table, forms, typescript), and added ahomepagepointing at the docs site.Why
Better discoverability: the package currently publishes with an empty npm description and no keywords, and the README does not say what the library is for or how it relates to the rest of the Cratis stack. This gives searchers (npm, GitHub, docs site) accurate category terms and ecosystem cross-links, with factual wording only.
Verification
Source/package.jsonparses as valid JSON.markdownlint-cli2passes on the changed files (the one remaining MD040 finding inSource/README.mdpre-exists this change).#licensing,#available-subpath-exports) verified against the package README headings; the "Related" cards reuse icon names already used in this docs file.