You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/getting-started.md
+63-13Lines changed: 63 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,17 +7,62 @@ permalink: /getting-started/
7
7
8
8
# Getting Started with PineTS
9
9
10
-
PineTS enables seamless conversion of Pine Script indicators to JavaScript/TypeScript code. It preserves the original functionality and behavior while providing robust handling of time-series data processing, technical analysis calculations, and Pine Script's distinctive scoping mechanisms.
10
+
PineTS is a JavaScript/TypeScript runtime that enables execution of Pine Script indicators in JavaScript environments. It supports two input formats:
11
+
12
+
1.**Native Pine Script v5/v6**_(experimental)_ - Run original Pine Script code directly
13
+
2.**PineTS Syntax** - A JavaScript/TypeScript syntax that closely mirrors Pine Script
14
+
15
+
It preserves the original functionality and behavior while providing robust handling of time-series data processing, technical analysis calculations, and Pine Script's distinctive scoping mechanisms.
11
16
12
17
## Installation
13
18
14
19
```bash
15
20
npm install pinets
16
21
```
17
22
18
-
## Usage Example
23
+
## Usage Examples
24
+
25
+
### Option 1: Run Native Pine Script Directly _(Experimental)_
26
+
27
+
Starting with v0.7.0, you can run original Pine Script code directly without conversion:
> **⚠️ Note**: Native Pine Script support is experimental. Some indicators may fail if they use API features not yet implemented. Check the [API Coverage](../api-coverage/) pages to verify compatibility.
58
+
59
+
---
60
+
61
+
### Option 2: Use PineTS Syntax
62
+
63
+
If you prefer or need more control, you can use PineTS syntax, which is a JavaScript/TypeScript version with minimal differences from Pine Script.
0 commit comments