Skip to content

Commit f802793

Browse files
authored
Updating the note about the v2 version. (#133)
# Describe Request Please describe your request. Fixed # (issue) # Change Type What is the type of this change.
1 parent cbdf8d5 commit f802793

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,17 @@
88

99
Indicator is a Golang module providing various stock technical analysis indicators, strategies, and a backtest framework for trading.
1010

11+
> [!IMPORTANT]
1112
> I have recently started working on the [v2 version](https://github.com/cinar/indicator/tree/v2). It is a complete rewrite of the library with the following goals:
1213
>
13-
> - Achieving and maintaining 100% code coverage, along with test files for each indicator and strategy.
14-
> - Operating on data streams (Go channels) for both inputs and outputs.
14+
> - Achieving and maintaining minimum of 90% code coverage.
15+
> - Having test data in CSV format for each indicator and strategy for each validation.
16+
> - Operating on data streams (Go channels) for both inputs and outputs. If you prefer using slices, helper functions like [helper.SliceToChan](helper/README.md#func-slicetochan) and [helper.ChanToSlice](helper/README.md#func-chantoslice) are available. Alternatively, you can still use the `v1 version`.
17+
> - Having each indicator and strategy fully configurable with no preset values.
1518
> - Supporting all numeric formats using Golang generics.
1619
17-
*I also have a TypeScript version of this module now at [Indicator TS](https://github.com/cinar/indicatorts).*
20+
> [!NOTE]
21+
> I also have a TypeScript version of this module now at [Indicator TS](https://github.com/cinar/indicatorts).
1822
1923
## Indicators Provided
2024

0 commit comments

Comments
 (0)