Skip to content

Commit 2a5e97a

Browse files
committed
docs: updates scope to @dschz/solid-uplot
1 parent 0449690 commit 2a5e97a

File tree

3 files changed

+24
-59
lines changed

3 files changed

+24
-59
lines changed

README.md

Lines changed: 17 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,27 @@
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" />
33
</p>
44

5-
# Template: SolidJS Library
5+
# @dschz/solid-uplot
66

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.
88
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.
1011

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
1713

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
1919

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
4521

4622
```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
5227
```
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`

jsr.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "template-solidjs-library",
2+
"name": "@dschz/solid-uplot",
33
"version": "0.0.0",
44
"license": "MIT",
55
"exports": "./src/index.tsx",

package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
{
2-
"name": "template-solidjs-library",
2+
"name": "@dschz/solid-uplot",
33
"version": "0.0.0",
4-
"description": "Template for SolidJS library using tsup for bundling. Configured with Bun, NVM, TypeScript, ESLint, Prettier, Vitest, and GHA",
4+
"description": "SolidJS wrapper for uPlot — ultra-fast, tiny time-series & charting library",
55
"type": "module",
6-
"author": "Daniel Sanchez <dsanc89@icloud.com>",
6+
"author": "Daniel Sanchez <dsanc89@pm.me>",
77
"license": "MIT",
8-
"homepage": "https://github.com/thedanchez/template-solidjs-library#readme",
8+
"homepage": "https://github.com/dsnchz/solid-uplot#readme",
99
"repository": {
1010
"type": "git",
11-
"url": "https://github.com/thedanchez/template-solidjs-library.git"
11+
"url": "https://github.com/dsnchz/solid-uplot.git"
1212
},
1313
"bugs": {
14-
"url": "https://github.com/thedanchez/template-solidjs-library/issues"
14+
"url": "https://github.com/dsnchz/solid-uplot/issues"
1515
},
1616
"publishConfig": {
1717
"access": "public"

0 commit comments

Comments
 (0)