Files
wickra/docs/README.md
T
kingchenc d59cd44043 docs: standardise language naming + binding security sections (#290)
* docs: standardise language naming and add binding security sections

Canonical binding list everywhere: Rust, Python, Node.js, WASM, C, C++, C#,
Go, Java, R. Use C# (not .NET) as the language label, WASM (not WebAssembly)
in prose, and frame the C ABI as a hub rather than a list item.

- Bump stale indicator counts (200+ -> 514) and family count (sixteen ->
  twenty-four) in the Node/Python/WASM and docs READMEs.
- Add a short Security section to all eight binding READMEs.
- Relabel benchmark rows (C -> C / C++, C# / .NET -> C#).
- Fix the 'language stecker' wording in the C#/Go/R API intros.
- Documentation only; no code or public API changes.

* release.yml: extend install snippets and expose version output

Add the missing registry installs to the release body (dotnet, go, Gradle/
Maven Central, r-universe) alongside cargo/pip/npm, and expose a v-stripped
'version' output from the tag step for the Gradle coordinate. Also fix the
C-ABI language order in the assets note (C# before Go).

* release.yml: correct the release body (10 languages, all registries)

Reframe the tagline to '10 languages' (native Rust/Python/Node.js/WASM + a C
ABI hub for C, C++, C#, Go, Java, R) instead of '4 language registries', note
that C#/Java/Go/R publish to NuGet/Maven/Go/r-universe via their own jobs, and
tidy the Node.js label and the C-ABI hub list.
2026-06-13 23:34:24 +02:00

1.8 KiB

Documentation

Wickra's full documentation lives at docs.wickra.org.

That includes:

  • Quickstarts for Rust, Python, Node, WASM, C, C#, Go, Java, and R.
  • A per-indicator deep dive for every one of the 514 indicators across the twenty-four families (Moving Averages, Momentum Oscillators, Trend & Directional, Price Oscillators, Volatility & Bands, Bands & Channels, Trailing Stops, Volume, Price Statistics, Ehlers / Cycle DSP, Pivots & S/R, DeMark, Ichimoku & Charts, Candlestick Patterns, Market Profile, Risk / Performance, Microstructure, Derivatives, Alt-Chart Bars, Market Breadth, Seasonality & Session, Chart Patterns, Harmonic Patterns, Fibonacci) — see the indicators overview.
  • Reference pages: warmup periods, streaming vs batch, indicator chaining, and the data layer.
  • Guides: Cookbook, TA-Lib migration, FAQ.

Editing the docs

The documentation site is a separate git repository at https://github.com/wickra-lib/wickra-docs. Open a pull request there to propose changes; the site is built with VitePress and deploys to docs.wickra.org.