|
1 | | -<p> |
2 | | - <img width="100%" src="https://assets.solidjs.com/banner?type=Ecosystem&background=tiles&project=library-name" alt="solid-create-script"> |
| 1 | +<p align="center"> |
| 2 | + <img src="https://assets.solidjs.com/banner?project=solid-uplot&type=Ecosystem&background=tiles" alt="@dschz/solid-uplot banner" /> |
3 | 3 | </p> |
4 | 4 |
|
5 | | -# Template: SolidJS Library |
| 5 | +# @dschz/solid-uplot |
6 | 6 |
|
7 | | -Template for [SolidJS](https://www.solidjs.com/) library package. Bundling of the library is managed by [tsup](https://tsup.egoist.dev/). |
| 7 | +> 💹 SolidJS wrapper for [uPlot](https://github.com/leeoniya/uPlot) — an ultra-fast, small footprint charting library for time-series data. |
8 | 8 |
|
9 | | -Other things configured include: |
| 9 | +This is the **official scoped version** of the previously unscoped `uplot-solid` package. |
| 10 | +It has been rebooted from scratch, starting at `v0.1.0` under the `@dschz` namespace to reflect improvements and future direction. |
10 | 11 |
|
11 | | -- Bun (for dependency management and running scripts) |
12 | | -- TypeScript |
13 | | -- ESLint / Prettier |
14 | | -- Solid Testing Library + Vitest (for testing) |
15 | | -- Playground app using library |
16 | | -- GitHub Actions (for all CI/CD) |
| 12 | +## ✨ Features |
17 | 13 |
|
18 | | -## Getting Started |
| 14 | +- ✅ Fully reactive SolidJS wrapper around uPlot |
| 15 | +- 🔌 Plugin system support |
| 16 | +- 🎯 Fine-grained control over chart lifecycle |
| 17 | +- 💡 Lightweight and fast |
| 18 | +- 💻 TypeScript support out of the box |
19 | 19 |
|
20 | | -Some pre-requisites before install dependencies: |
21 | | - |
22 | | -- Install Node Version Manager (NVM) |
23 | | - ```bash |
24 | | - curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash |
25 | | - ``` |
26 | | -- Install Bun |
27 | | - ```bash |
28 | | - curl -fsSL https://bun.sh/install | bash |
29 | | - ``` |
30 | | - |
31 | | -### Installing Dependencies |
32 | | - |
33 | | -```bash |
34 | | -nvm use |
35 | | -bun install |
36 | | -``` |
37 | | - |
38 | | -### Local Development Build |
39 | | - |
40 | | -```bash |
41 | | -bun start |
42 | | -``` |
43 | | - |
44 | | -### Linting & Formatting |
| 20 | +## 📦 Installation |
45 | 21 |
|
46 | 22 | ```bash |
47 | | -bun run lint # checks source for lint violations |
48 | | -bun run format # checks source for format violations |
49 | | - |
50 | | -bun run lint:fix # fixes lint violations |
51 | | -bun run format:fix # fixes format violations |
| 23 | +npm install solid-js uplot @dschz/solid-uplot |
| 24 | +pnpm install solid-js uplot @dschz/solid-uplot |
| 25 | +yarn install solid-js uplot @dschz/solid-uplot |
| 26 | +bun install solid-js uplot @dschz/solid-uplot |
52 | 27 | ``` |
53 | | - |
54 | | -### Contributing |
55 | | - |
56 | | -The only requirements when contributing are: |
57 | | - |
58 | | -- You keep a clean git history in your branch |
59 | | - - rebasing `main` instead of making merge commits. |
60 | | -- Using proper commit message formats that adhere to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) |
61 | | - - Additionally, squashing (via rebase) commits that are not [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) |
62 | | -- CI checks pass before merging into `main` |
0 commit comments