tickup 1.0.38 → 1.0.39
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 +15 -0
- package/documentation/01-introduction.md +2 -0
- package/documentation/README.md +21 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -75,6 +75,21 @@ export function App() {
|
|
|
75
75
|
- **[OHLC schema & debugging](./documentation/17-interval-schema-and-debugging.md)** — Data format and common “chart not showing” fixes.
|
|
76
76
|
- **[Comparison showcase](./documentation/18-comparison-showcase.md)** — **`#/compare`** to audit Core vs Prime before choosing a tier.
|
|
77
77
|
- [Quick start](./documentation/03-quick-start.md) · [Imperative API](./documentation/06-imperative-api.md) · [Data & live updates](./documentation/07-data-and-live-updates.md)
|
|
78
|
+
- [Contributing](./CONTRIBUTING.md) — how to collaborate on the open-source core.
|
|
79
|
+
|
|
80
|
+
## Open source & collaborators
|
|
81
|
+
|
|
82
|
+
**TickUp Core** (this repository and the **`tickup`** package on npm) is **open source** under the **[MIT License](./LICENSE)**. You can study it, ship it in commercial products, fork it, and send improvements back—no permission slip required beyond the license terms.
|
|
83
|
+
|
|
84
|
+
If you care about **financial UX**, **canvas performance**, **TypeScript APIs**, or **documentation clarity**, you belong here. We welcome **first-time contributors** as much as regulars: open an issue with a question, a repro, or a rough idea; share a small doc fix or a focused PR; or pair on a larger change after a quick discussion in an issue so nobody wastes effort.
|
|
85
|
+
|
|
86
|
+
**Ways to reach the maintainer (Bar Damri):**
|
|
87
|
+
|
|
88
|
+
- **Email:** [bardamri1702@gmail.com](mailto:bardamri1702@gmail.com) — best for private questions, security reports, or collaboration proposals before they become public threads.
|
|
89
|
+
- **Website:** [bardamri.com](https://bardamri.com)
|
|
90
|
+
- **GitHub:** [Issues & pull requests](https://github.com/BARDAMRI/tickup-charts/issues) on this repo for bugs, features, and code review in the open.
|
|
91
|
+
|
|
92
|
+
See **[Contributing](./CONTRIBUTING.md)** for branch expectations, build commands, and PR hygiene.
|
|
78
93
|
|
|
79
94
|
## TickUp Prime
|
|
80
95
|
|
|
@@ -4,6 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
This package is the **Standard Edition** (**MIT**). It is aimed at **dashboards**, **admin tools**, and **embedded widgets** where you want a **real chart**, not a screenshot, without building canvas math from scratch.
|
|
6
6
|
|
|
7
|
+
**Open source:** TickUp Core is developed in the open. If you use it, improve it, or teach others with it, consider **joining the effort**—documentation fixes, reproducible bug reports, and focused pull requests are all valuable. You do not need prior maintainer approval to **open an issue**; for anything sensitive or exploratory, **Bar Damri** is reachable at **[bardamri1702@gmail.com](mailto:bardamri1702@gmail.com)** ([bardamri.com](https://bardamri.com)). Public collaboration happens on **[GitHub](https://github.com/BARDAMRI/tickup-charts/issues)**. See **[Contributing](../CONTRIBUTING.md)** for how to run builds and propose changes.
|
|
8
|
+
|
|
7
9
|
**New here?** Start with the **[Getting started — Grand Tour](./00-getting-started.md)** (install from zero + Hello World).
|
|
8
10
|
|
|
9
11
|
---
|
package/documentation/README.md
CHANGED
|
@@ -2,6 +2,26 @@
|
|
|
2
2
|
|
|
3
3
|
Integration guides for **TickUp Core** (Standard Edition): the MIT open-source React charting library published as the **`tickup`** npm package.
|
|
4
4
|
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Open source & collaboration
|
|
8
|
+
|
|
9
|
+
This project is **open source** (**MIT**). The docs you are reading ship inside the npm tarball on purpose: we want integrators *and* contributors to have the same source of truth.
|
|
10
|
+
|
|
11
|
+
**You are invited to collaborate.** Whether you spot a typo in a guide, want to harden an edge case in live data, or dream up a better default for axes—we’d rather you **open an issue** or **draft a PR** than assume the door is closed. Small, reviewable changes often merge fastest; bigger ideas benefit from a short issue thread first so maintainers and contributors align.
|
|
12
|
+
|
|
13
|
+
**Contact the maintainer — Bar Damri**
|
|
14
|
+
|
|
15
|
+
| Channel | Use for |
|
|
16
|
+
|---------|---------|
|
|
17
|
+
| **[bardamri1702@gmail.com](mailto:bardamri1702@gmail.com)** | Direct questions, security-sensitive reports, or “is this in scope?” before opening a public issue. |
|
|
18
|
+
| **[bardamri.com](https://bardamri.com)** | Background and other work. |
|
|
19
|
+
| **[GitHub Issues / PRs](https://github.com/BARDAMRI/tickup-charts/issues)** | Bugs, features, and code contributions in the open. |
|
|
20
|
+
|
|
21
|
+
Workflow and local build steps: **[Contributing](../CONTRIBUTING.md)** (repository root).
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
5
25
|
## Start here (zero-knowledge path)
|
|
6
26
|
|
|
7
27
|
1. **[Getting started — Grand Tour](./00-getting-started.md)** — Create a React app, install peers, copy-paste **Hello World**, learn the **5k / 1 Hz / 3 overlays** guardrails.
|
|
@@ -29,6 +49,7 @@ The **example app** in [`../example/`](../example/) (Vite + React) demonstrates
|
|
|
29
49
|
| 0 | [Getting started](./00-getting-started.md) | Grand Tour: install, Hello World, guardrails |
|
|
30
50
|
| 1 | [Introduction](./01-introduction.md) | What Core is; doc map |
|
|
31
51
|
| — | [Glossary](./01-glossary.md) | Intervals, ranges, products, placements |
|
|
52
|
+
| — | [Contributing](../CONTRIBUTING.md) | Open-source collaboration, PRs, contact |
|
|
32
53
|
| 2 | [Installation](./02-installation.md) | Peers, npm, bundlers |
|
|
33
54
|
| 3 | [Quick start](./03-quick-start.md) | Minimal embed and data flow |
|
|
34
55
|
| 4 | [Products & layout](./04-products-and-layout.md) | Pulse, Flow, Command, Desk, Prime tier |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "tickup",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.39",
|
|
4
4
|
"description": "High-performance React financial charts. Canvas 2D rendering, advanced technical analysis tools, and real-time data streaming.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/tickup.cjs.js",
|