Skip to content

Commit 3ab9c2f

Browse files
authored
Documentation update (#523)
Documentation update.
1 parent 7213e7c commit 3ab9c2f

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ Indicator is a TypeScript module providing various stock technical analysis indi
1010

1111
_This is a clone of my [Indicator Go](https://github.com/cinar/indicator) Golang module._
1212

13+
## ⚠️ Risk Disclosure & Disclaimer
14+
15+
**Financial Risk:** Trading stocks, futures, and cryptocurrencies involves significant risk of loss and is not suitable for every investor. The use of leveraged instruments can lead to losses greater than the initial investment.
16+
17+
**Not Financial Advice:** The information and tools provided in this project are strictly for educational and informational purposes and are not to be construed as advice or solicitation to buy or sell any security. They do NOT constitute financial, investment, or trading advice. Onur Cinar is not a financial advisor.
18+
19+
**No Warranties:** This software is provided "AS IS," without warranty of any kind. Technical analysis indicators are based on historical data and do not guarantee future results. While we strive for 90%+ test coverage, software can contain bugs.
20+
21+
**Limitation of Liability:** In no event shall the author or contributors be liable for any financial loss, data loss, or any other damages arising from the use of this library. Use at your own risk.
22+
1323
## Indicators Provided
1424

1525
The following list of indicators are currently supported by this package:
@@ -180,17 +190,6 @@ const lows = [1, 2, 3, 4];
180190
const result = ao(highs, lows);
181191
```
182192

183-
⚠️ Risk Disclosure & Disclaimer
184-
-------------------------------
185-
186-
**Financial Risk:** Trading stocks, futures, and cryptocurrencies involves significant risk of loss and is not suitable for every investor. The use of leveraged instruments can lead to losses greater than the initial investment.
187-
188-
**Not Financial Advice:** The information and tools provided in this project are strictly for educational and informational purposes and are not to be construed as advice or solicitation to buy or sell any security. They do NOT constitute financial, investment, or trading advice. Onur Cinar is not a financial advisor.
189-
190-
**No Warranties:** This software is provided "AS IS," without warranty of any kind. Technical analysis indicators are based on historical data and do not guarantee future results. While we strive for 90%+ test coverage, software can contain bugs.
191-
192-
**Limitation of Liability:** In no event shall the author or contributors be liable for any financial loss, data loss, or any other damages arising from the use of this library. Use at your own risk.
193-
194193
## License
195194

196195
The source code is provided under MIT License.

0 commit comments

Comments
 (0)