pinets 0.2.1 → 0.5.0

package/README.md

@@ -1,7 +1,8 @@
 [![npm version](https://img.shields.io/npm/v/pinets.svg?style=flat-square)](https://www.npmjs.com/package/pinets)
 [![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-blue.svg?style=flat-square)](https://opensource.org/licenses/AGPL-3.0)
-[![Documentation](https://img.shields.io/badge/docs-github--pages-blue?style=flat-square)](https://alaa-eddine.github.io/PineTS/)
-[![Reddit](https://img.shields.io/reddit/subreddit-subscribers/PineTS?style=flat-square&logo=reddit)](https://www.reddit.com/r/PineTS/)
+[![Coverage](./.github/badges/coverage.svg)](./.github/badges/coverage.svg)
+[![Documentation](https://img.shields.io/badge/docs-github--pages-blue?style=flat-square)](https://quantforgeorg.github.io/PineTS/)
+[![Reddit](https://img.shields.io/reddit/subreddit-subscribers/QuantForge?style=flat-square&logo=reddit)](https://www.reddit.com/r/QuantForge/)
 
 This project aims to provide a Javascript/Typescript port for Tradingview's Pine Script.
 The current version does not run Pine Script directly, instead it runs a close Javascript equivalent called PineTS.
@@ -21,12 +22,13 @@ PineTS enables seamless conversion of Pine Script indicators to JavaScript/TypeS
 Bellow are two ports of Pine Script indicators running in the browser.
 PineTS is used to generate plot data, and tradingview light weight chart is used to display the plot.
 
--   [Williams Vix Fix](https://alaa-eddine.github.io/PineTS/indicators/willvixfix/)
--   [Squeeze Momentum](https://alaa-eddine.github.io/PineTS/indicators/sqzmom/)
+-   [Williams Vix Fix](https://quantforgeorg.github.io/PineTS/indicators/willvixfix/)
+-   [Squeeze Momentum](https://quantforgeorg.github.io/PineTS/indicators/sqzmom/)
 
 ## Key Features
 
 -   **Pine Script Compatibility**: Supports Pine Script v5+ syntax and functionality
+-   **High Precision**: Aims for the same precision as Pine Script (up to the 8th digit)
 -   **Time-Series Processing**: Handles historical data and series operations
 -   **Technical Analysis Functions**: Comprehensive set of TA indicators and calculations
 -   **Mathematical Operations**: Advanced mathematical functions and precision handling
@@ -65,7 +67,13 @@ npm install pinets
 
 Original Pine Script:
 
+<table>
+<tr>
+<td>
+
 ```javascript
+/*==[ Original Pine Script ]==*/
+
 //@version=5
 indicator('My EMA Cross Strategy');
 
@@ -82,22 +90,32 @@ _oo = open;
 _oo = math.abs(open[1] - close[2]);
 ```
 
-Equivalent PineTS code:
+</td>
+<td>
 
 ```javascript
-const ema9 = ta.ema(close, 9);
-const ema18 = ta.ema(close, 18);
+/*==[ Equivalent PineTS ]==*/
+
+//
+//'My EMA Cross Strategy';
 
-const bull_bias = ema9 > ema18;
-const bear_bias = ema9 < ema18;
+let ema9 = ta.ema(close, 9);
+let ema18 = ta.ema(close, 18);
 
-const prev_close = close[1];
-const diff_close = close - prev_close;
+let bull_bias = ema9 > ema18;
+let bear_bias = ema9 < ema18;
+
+let prev_close = close[1];
+let diff_close = close - prev_close;
 
 let _oo = open;
 _oo = math.abs(open[1] - close[2]);
 ```
 
+</td>
+</tr>
+</table>
+
 ### Running PineTS Code
 
 ```javascript
@@ -111,14 +129,14 @@ const { result } = await pineTS.run((context) => {
     const { ta, math } = context;
     const { close, open } = context.data;
 
-    const ema9 = ta.ema(close, 9);
-    const ema18 = ta.ema(close, 18);
+    let ema9 = ta.ema(close, 9);
+    let ema18 = ta.ema(close, 18);
 
-    const bull_bias = ema9 > ema18;
-    const bear_bias = ema9 < ema18;
+    let bull_bias = ema9 > ema18;
+    let bear_bias = ema9 < ema18;
 
-    const prev_close = close[1];
-    const diff_close = close - prev_close;
+    let prev_close = close[1];
+    let diff_close = close - prev_close;
 
     let _oo = open;
     _oo = math.abs(open[1] - close[2]);
@@ -127,7 +145,7 @@ const { result } = await pineTS.run((context) => {
 });
 ```
 
-> **📖 For detailed documentation on initialization options, parameters, and advanced usage, see the [Initialization and Usage Guide](https://alaa-eddine.github.io/PineTS/initialization-and-usage/)**
+> **📖 For detailed documentation on initialization options, parameters, and advanced usage, see the [Initialization and Usage Guide](https://quantforgeorg.github.io/PineTS/initialization-and-usage/)**
 
 ## Key Differences from Pine Script
 
@@ -139,6 +157,8 @@ const { result } = await pineTS.run((context) => {
 
 ## Project Goals
 
+PineTS aims for **full coverage** of Pine Script functions and capabilities. The ultimate goal is to enable running **original Pine Script code directly** without manual conversion to PineTS syntax.
+
 -   Runtime Transpiler
 -   Core Pine Script functions and variables
 -   Series and scope management