Skip to content

docs: make usage example self-contained - #136

Merged
chrispader merged 1 commit into
margelo:mainfrom
huytdps13400:fix/109-self-contained-usage-example
Sep 17, 2026
Merged

chrispader merged 1 commit into
margelo:mainfrom
huytdps13400:fix/109-self-contained-usage-example

Conversation

@huytdps13400

Copy link
Copy Markdown
Contributor

Summary

  • replace the undefined usePriceHistory() call with a complete GraphPoint[] example
  • import the public GraphPoint type so the supported data shape is visible immediately
  • clarify that consumers provide their own data and that the x-axis is date-based

Fixes #109.

Verification

Using the repository Node.js version (22.20.0):

  • yarn prettier --check README.md
  • yarn test --runInBand — 2 suites, 3 tests passed
  • yarn typecheck
  • yarn lint — 0 errors; one pre-existing no-shadow warning in src/AnimatedLineGraph.tsx
  • yarn prepare
  • CI=1 yarn workspace react-native-graph-example expo export --platform web --output-dir /tmp/graph-109-web-dist
  • git diff --check

This is documentation-only; no runtime or public API behavior changes.

@chrispader chrispader left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@chrispader
chrispader merged commit f6dc662 into margelo:main Sep 17, 2026
@chrispader chrispader mentioned this pull request Sep 17, 2026
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.

How to use it?README is not clear

2 participants