[Components] Update README #2303
Draft
+56
−6
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
ziyunp
force-pushed
the
zpoh/components-readme
branch
from
8b4585f to
7f63ffe
Compare
KuberSethi
reviewed
Dec 17, 2025
packages/react-components/README.md
Outdated
| **Prerequisites:** | ||
|
|
||
| This package provides reusable React components built on top of `@osdk/react` for common Ontology SDK use cases. | ||
| - React 18+ |
Contributor
There was a problem hiding this comment.
I'm actually not sure if we support React 19 😅
Contributor
Author
There was a problem hiding this comment.
In package.json, we have peerDependencies set to
"react": "^17 || ^18 || ^19",
KuberSethi
reviewed
Dec 17, 2025
|
|
||
| ```typescript | ||
| import {/* your components */} from "@osdk/components"; | ||
| ## Components |
Contributor
There was a problem hiding this comment.
nit: could go either way but I don't think including this project/planning level info is helpful
KuberSethi
reviewed
Dec 17, 2025
|
|
||
| ```sh | ||
| npm install @osdk/react-components | ||
| npm install @osdk/react-components @osdk/react |
Contributor
There was a problem hiding this comment.
Can we make it clear the relationship between @osdk/react-components and @osdk/react?
KuberSethi
reviewed
Dec 17, 2025
Contributor
KuberSethi
left a comment
KuberSethi
left a comment
There was a problem hiding this comment.
README generally looks good - think you might need to rebase
ziyunp
force-pushed
the
zpoh/components-readme
branch
from
7f63ffe to
d682f62
Compare
ziyunp
force-pushed
the
zpoh/components-readme
branch
from
8d98790 to
1c65ec7
Compare
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.
No description provided.