From e4422c8662974ea02b37a52d4d6c76c79427ee95 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Sun, 6 Dec 2020 23:02:54 -0500 Subject: [PATCH] chore: update docs (#202) * update main README.md * update SuperTrend docs +semver: minor --- README.md | 2 +- indicators/SuperTrend/README.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6f03721d0..addcacfee 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ [Skender.Stock.Indicators](https://www.nuget.org/packages/Skender.Stock.Indicators) is a .NET library that produces [stock indicators](https://daveskender.github.io/Stock.Indicators/docs/INDICATORS.html). Send in historical stock price quotes and get back desired technical indicators (such as moving average, relative strength, stochastic oscillator, parabolic SAR, etc). Nothing more. -It can be used in any market analysis software that uses the standard OHLCV price series format, to include stocks, forex, cryptocurrencies, etc. We had private trading algorithms, machine learning, and charting applications in mind when originally creating this open library. +It can be used in any market analysis software for standard OHLCV price quotes, to include equities, commodities, forex, cryptocurrencies, etc. We had private trading algorithms, machine learning, and charting systems in mind when originally creating this community library. Explore more information: diff --git a/indicators/SuperTrend/README.md b/indicators/SuperTrend/README.md index 64143f2ef..ec58e5290 100644 --- a/indicators/SuperTrend/README.md +++ b/indicators/SuperTrend/README.md @@ -1,6 +1,6 @@ # SuperTrend -[SuperTrend](https://www.barchart.com/education/technical-indicators/supertrend) attempts to determine the primary trend of Close price by using [Average True Range (ATR)](../Atr/README.md) band thresholds. +[SuperTrend](https://www.barchart.com/education/technical-indicators/supertrend) attempts to determine the primary trend of Close prices by using [Average True Range (ATR)](../Atr/README.md) band thresholds. It can indicate a buy/sell signal or a trailing stop when the trend changes. ![image](chart.png) @@ -38,7 +38,7 @@ WARNING: the line segment before the first reversal is unreliable due to an init | `UpperBand` | decimal | Upper band only (bearish/red) | `LowerBand` | decimal | Lower band only (bullish/green) -`UpperBand` and `LowerBand` values are provided to differentiate bullish vs bearish trends and to clearly demark trend reversal. `SuperTrend` is the contigous combination of both upper and lower line data. +`UpperBand` and `LowerBand` values are provided to differentiate bullish vs bearish trends and to clearly demark trend reversal. `SuperTrend` is the contiguous combination of both upper and lower line data. ## Example