stream-charts 2.0.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[](https://www.npmjs.com/package/stream-charts) [](https://github.com/robphilipp/stream-charts/actions/workflows/main.yml) [](LICENSE)
|
|
2
2
|
|
|
3
3
|
[Homepage](https://robphilipp.github.io/stream-charts/) •
|
|
4
4
|
[API Docs](https://robphilipp.github.io/stream-charts/docs/modules.html) •
|
|
@@ -31,7 +31,9 @@ Five plot types are available:
|
|
|
31
31
|
| [<PoincarePlot/>](#poincare-plot) | a sequence plotted against itself (`f[n+m](x)` vs `f[n](x)`) | iterated maps, chaotic systems |
|
|
32
32
|
| [<OutlierPlot/>](#outlier-plot) | values over time, with confidence bands that flag outliers | a price index with 1σ, 2σ, 3σ bands |
|
|
33
33
|
|
|
34
|
-
> Try
|
|
34
|
+
> Try the demo app online: [](https://codespaces.new/robphilipp/stream-charts?quickstart=1)
|
|
35
|
+
>
|
|
36
|
+
> This opens the repository in a GitHub codespace, installs it, and starts the demo app, which opens in a new browser tab (the first start takes a few minutes). You'll need a GitHub account, and the codespace counts against your account's free monthly Codespaces hours.
|
|
35
37
|
|
|
36
38
|
## <span id="content">content</span>
|
|
37
39
|
|
|
@@ -87,10 +89,10 @@ What to install depends on what you'd like to do:
|
|
|
87
89
|
### <span id="installation">using the library in your application</span> [↑](#content "back to contents")
|
|
88
90
|
|
|
89
91
|
```shell
|
|
90
|
-
npm install stream-charts
|
|
92
|
+
npm install stream-charts react react-dom rxjs d3
|
|
91
93
|
```
|
|
92
94
|
|
|
93
|
-
> This README describes version 2,
|
|
95
|
+
> This README describes version 2, whose API is different from version 1's. To upgrade from 1.x, see [migrating from 1.x](#migrating).
|
|
94
96
|
|
|
95
97
|
`stream-charts` has four peer dependencies: React 19 (`react`, `react-dom`), [RxJS](https://rxjs.dev) 7, and [d3](https://d3js.org) 7. Your application uses them directly – to render the components, create the observables that feed the charts, and pass d3 scales and curves to the axes and plots – so the library shares your copies rather than bringing its own. TypeScript users get d3's type definitions (`@types/d3`) with the library.
|
|
96
98
|
|