gavindiaz/wickra
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: refresh the stale Python and Node binding READMEs

Browse Source 
The Python binding README still advertised "63 indicators across four
families" with the pre-restructure five-group taxonomy, missing the eight
indicators added since. Update it to "71 indicators across eight families"
with the catalogue grouped to match the main README.

The Node binding README referred to the package as @wickra/wickra in its
title, install command and import example; the published package is named
wickra (per bindings/node/package.json). Correct all three.
This commit is contained in:
kingchenc
2026-05-22 22:21:49 +02:00
parent 91f24946a6
commit c6938e8473
2 changed files with 22 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bindings/node/README.md
+3 -3
View File
@@ -1,4 +1,4 @@
# @wickra/wickra # wickra
Node.js bindings for the Wickra streaming-first technical indicators library. Node.js bindings for the Wickra streaming-first technical indicators library.
@@ -7,7 +7,7 @@ Node.js bindings for the Wickra streaming-first technical indicators library.
Once published, install per platform via the precompiled native package: Once published, install per platform via the precompiled native package:
```bash ```bash
npm install @wickra/wickra npm install wickra
``` ```
## Build from source ## Build from source
@@ -26,7 +26,7 @@ produces a `wickra.<platform>-<arch>.node` binary in the package root that
## Usage ## Usage
```js ```js
import { SMA, RSI, MACD, version } from '@wickra/wickra'; import { SMA, RSI, MACD, version } from 'wickra';
console.log('wickra', version()); console.log('wickra', version());
bindings/python/README.md
+19 -15
View File
@@ -26,22 +26,26 @@ for price in live_prices:
## What's included ## What's included
63 streaming-first indicators across four families plus a statistics group. 71 streaming-first indicators across eight families. Every one passes a
Every one passes a `batch == streaming` equivalence test and reference-value `batch == streaming` equivalence test and reference-value tests:
tests:
- **Trend** — SMA, EMA, WMA, DEMA, TEMA, HMA, KAMA, SMMA, TRIMA, ZLEMA, T3, - **Moving Averages** — SMA, EMA, WMA, DEMA, TEMA, HMA, KAMA, SMMA, TRIMA,
VWMA ZLEMA, T3, VWMA
- **Momentum** — RSI (Wilder), MACD, Stochastic, CCI, ROC, WilliamsR, ADX, - **Momentum Oscillators** — RSI (Wilder), Stochastic, CCI, ROC, Williams %R,
MFI, TRIX, AwesomeOscillator, Aroon, MOM, CMO, TSI, PMO, StochRSI, MFI, Awesome Oscillator, MOM, CMO, TSI, PMO, StochRSI, Ultimate Oscillator
UltimateOscillator, PPO, DPO, Coppock, AroonOscillator, Vortex, MassIndex - **Trend & Directional** — MACD, ADX (+DI/-DI), Aroon, TRIX, Aroon
- **Volatility** — BollingerBands, ATR, Keltner, Donchian, PSAR, NATR, StdDev, Oscillator, Vortex, Mass Index, Choppiness Index, Vertical Horizontal Filter
UlcerIndex, HistoricalVolatility, BollingerBandwidth, PercentB, SuperTrend, - **Price Oscillators** — PPO, DPO, Coppock, Accelerator Oscillator, Balance
ChandelierExit, ChandeKrollStop, AtrTrailingStop of Power
- **Volume** — OBV, VWAP, ADL, VolumePriceTrend, ChaikinMoneyFlow, - **Volatility & Bands** — ATR, Bollinger Bands, Keltner Channels, Donchian
ChaikinOscillator, ForceIndex, EaseOfMovement Channels, NATR, StdDev, Ulcer Index, Historical Volatility, Bollinger
- **Statistics** — TypicalPrice, MedianPrice, WeightedClose, LinearRegression, Bandwidth, %B, True Range, Chaikin Volatility
LinRegSlope - **Trailing Stops** — Parabolic SAR, SuperTrend, Chandelier Exit, Chande
Kroll Stop, ATR Trailing Stop
- **Volume** — OBV, VWAP (cumulative + rolling), ADL, Volume-Price Trend,
Chaikin Money Flow, Chaikin Oscillator, Force Index, Ease of Movement
- **Price Statistics** — Typical Price, Median Price, Weighted Close, Linear
Regression, Linear Regression Slope, Z-Score, Linear Regression Angle
## Why streaming-first matters ## Why streaming-first matters