From c6938e8473e237a79396ca8066758ac2d6f22d76 Mon Sep 17 00:00:00 2001 From: kingchenc Date: Fri, 22 May 2026 22:21:49 +0200 Subject: [PATCH] docs: refresh the stale Python and Node binding READMEs 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. --- bindings/node/README.md | 6 +++--- bindings/python/README.md | 34 +++++++++++++++++++--------------- 2 files changed, 22 insertions(+), 18 deletions(-) diff --git a/bindings/node/README.md b/bindings/node/README.md index 289a835e..70a7c86f 100644 --- a/bindings/node/README.md +++ b/bindings/node/README.md @@ -1,4 +1,4 @@ -# @wickra/wickra +# wickra 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: ```bash -npm install @wickra/wickra +npm install wickra ``` ## Build from source @@ -26,7 +26,7 @@ produces a `wickra.-.node` binary in the package root that ## Usage ```js -import { SMA, RSI, MACD, version } from '@wickra/wickra'; +import { SMA, RSI, MACD, version } from 'wickra'; console.log('wickra', version()); diff --git a/bindings/python/README.md b/bindings/python/README.md index f112617c..ce6dc84d 100644 --- a/bindings/python/README.md +++ b/bindings/python/README.md @@ -26,22 +26,26 @@ for price in live_prices: ## What's included -63 streaming-first indicators across four families plus a statistics group. -Every one passes a `batch == streaming` equivalence test and reference-value -tests: +71 streaming-first indicators across eight families. Every one passes a +`batch == streaming` equivalence test and reference-value tests: -- **Trend** — SMA, EMA, WMA, DEMA, TEMA, HMA, KAMA, SMMA, TRIMA, ZLEMA, T3, - VWMA -- **Momentum** — RSI (Wilder), MACD, Stochastic, CCI, ROC, WilliamsR, ADX, - MFI, TRIX, AwesomeOscillator, Aroon, MOM, CMO, TSI, PMO, StochRSI, - UltimateOscillator, PPO, DPO, Coppock, AroonOscillator, Vortex, MassIndex -- **Volatility** — BollingerBands, ATR, Keltner, Donchian, PSAR, NATR, StdDev, - UlcerIndex, HistoricalVolatility, BollingerBandwidth, PercentB, SuperTrend, - ChandelierExit, ChandeKrollStop, AtrTrailingStop -- **Volume** — OBV, VWAP, ADL, VolumePriceTrend, ChaikinMoneyFlow, - ChaikinOscillator, ForceIndex, EaseOfMovement -- **Statistics** — TypicalPrice, MedianPrice, WeightedClose, LinearRegression, - LinRegSlope +- **Moving Averages** — SMA, EMA, WMA, DEMA, TEMA, HMA, KAMA, SMMA, TRIMA, + ZLEMA, T3, VWMA +- **Momentum Oscillators** — RSI (Wilder), Stochastic, CCI, ROC, Williams %R, + MFI, Awesome Oscillator, MOM, CMO, TSI, PMO, StochRSI, Ultimate Oscillator +- **Trend & Directional** — MACD, ADX (+DI/-DI), Aroon, TRIX, Aroon + Oscillator, Vortex, Mass Index, Choppiness Index, Vertical Horizontal Filter +- **Price Oscillators** — PPO, DPO, Coppock, Accelerator Oscillator, Balance + of Power +- **Volatility & Bands** — ATR, Bollinger Bands, Keltner Channels, Donchian + Channels, NATR, StdDev, Ulcer Index, Historical Volatility, Bollinger + Bandwidth, %B, True Range, Chaikin Volatility +- **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