Skip to content

Commit 67d2856

Browse files
committed
Update readme
1 parent acda11b commit 67d2856

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PyIndicators
22

3-
PyIndicators is a powerful and user-friendly Python library for technical analysis indicators and metrics. Written entirely in Python, it requires no external dependencies, ensuring seamless integration and ease of use.
3+
PyIndicators is a powerful and user-friendly Python library for technical analysis indicators, metrics and helper functions. Written entirely in Python, it requires no external dependencies, ensuring seamless integration and ease of use.
44

55
## Installation
66

@@ -14,12 +14,13 @@ pip install pyindicators
1414

1515
* Native Python implementation, no external dependencies needed except for Polars or Pandas
1616
* Dataframe first approach, with support for both pandas dataframes and polars dataframes
17+
* Supports python version 3.9 and above.
1718
* [Trend indicators](#trend-indicators)
1819
* [Simple Moving Average (SMA)](#simple-moving-average-sma)
1920
* [Exponential Moving Average (EMA)](#exponential-moving-average-ema)
2021
* [Momentum indicators](#momentum-indicators)
2122
* [Relative Strength Index (RSI)](#relative-strength-index-rsi)
22-
* [Relative Strength Index Wilders method (RSI)](#wilders-relative-strength-index-wilders-rsi)
23+
* [Relative Strength Index Wilders method (Wilders RSI)](#wilders-relative-strength-index-wilders-rsi)
2324
* [Indicator helpers](#indicator-helpers)
2425
* [Crossover](#crossover)
2526
* [Is Crossover](#is-crossover)
@@ -30,6 +31,10 @@ pip install pyindicators
3031

3132
#### Simple Moving Average (SMA)
3233

34+
Smooth out price data to identify trend direction.
35+
36+
>sma(data: DataFrame, source_column: str, period: int, result_column: Optional[str]) - DataFrame
37+
3338
```python
3439
from investing_algorithm_framework import CSVOHLCVMarketDataSource
3540

0 commit comments

Comments
 (0)