Skip to content

Commit

Permalink
chore: update docs (#202)
Browse files Browse the repository at this point in the history
* update main README.md
* update SuperTrend docs

+semver: minor
  • Loading branch information
DaveSkender authored Dec 7, 2020
1 parent d755d6b commit e4422c8
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions indicators/SuperTrend/README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit e4422c8

Please sign in to comment.