Skip to content

Commit 1b8ef19

Browse files
committed
Update readme
1 parent 0c44f4e commit 1b8ef19

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
# Technical Analysis Library for .NET
22

3-
TALib.NETCore is an independent .NET adaptation of the renowned Technical Analysis Library (TA-Lib) originally developed by Mario Fortier - an open-source ANSI C library, which offers a comprehensive suite of functions for technical analysis of financial time series data. \
4-
It is written entirely in C# for the .NET platform. This repository contains the source code of the library's latest version, licensed under The GNU Lesser General Public License. This license allows the library to be freely used, including in commercial projects, subject to certain conditions. \
3+
``TALib.NETCore`` is an independent .NET adaptation of the renowned Technical Analysis Library (TA-Lib) originally developed by Mario Fortier -
4+
an open-source ANSI C library, which offers a comprehensive suite of functions for technical analysis of financial time series data. \
5+
It is written entirely in C# with zero dependencies for the .NET platform.
6+
This repository contains the source code of the library's latest version, licensed under The GNU Lesser General Public License.
7+
This license allows the library to be freely used, including in commercial projects, subject to certain conditions.
58

6-
[![License](https://img.shields.io/github/license/hmG3/TA-Lib.NETCore?logo=open-source-initiative)](https://opensource.org/licenses/LGPL-3.0)
9+
[![License](https://img.shields.io/github/license/hmG3/TA-Lib.NETCore?logo=open-source-initiative)](https://opensource.org/license/LGPL-3.0)
710
[![.NET8.0](https://img.shields.io/badge/.NET-8.0-blue?style=flat-square)](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
811
[![NuGet](https://img.shields.io/nuget/v/TALib.NETCore.svg?logo=nuget)](https://nuget.org/packages/TALib.NETCore)
912
[![NuGet](https://img.shields.io/nuget/dt/TALib.NETCore.svg)](https://nuget.org/packages/TALib.NETCore)\
10-
[![Build status](https://github.com/hmG3/TA-Lib.NETCore/actions/workflows/main-automation.yml/badge.svg)](https://github.com/hmG3/TA-Lib.NETCore/actions/workflows/main-automation.yml)
13+
[![test-analyse](https://github.com/hmG3/TA-Lib.NETCore/actions/workflows/test-analyse.yml/badge.svg)](https://github.com/hmG3/TA-Lib.NETCore/actions/workflows/test-analyse.yml)
1114
[![Coverage status](https://codecov.io/gh/hmG3/TA-Lib.NETCore/graph/badge.svg?token=5UZLT4JBHQ)](https://codecov.io/gh/hmG3/TA-Lib.NETCore)
1215
[![Maintainability rating](https://sonarcloud.io/api/project_badges/measure?project=hmG3_TA-Lib.NETCore&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=hmG3_TA-Lib.NETCore)
1316
[![Code quality](https://app.codacy.com/project/badge/Grade/6fcd7ac9e7d94c0d896638418318e2d0)](https://app.codacy.com/gh/hmG3/TA-Lib.NETCore/dashboard)
@@ -16,7 +19,8 @@ It is written entirely in C# for the .NET platform. This repository contains the
1619

1720
## Installation
1821

19-
A compiled binary of TALib.NETCore 0.4 is provided by the `TALib.NETCore` NuGet package. To install it, run the following command in the Package Manager Console:
22+
A compiled binary of the library is provided by the `TALib.NETCore` NuGet package.
23+
To install it, run the following command in the Package Manager Console:
2024

2125
```shell
2226
Install-Package TALib.NETCore
@@ -28,6 +32,10 @@ or in .NET Core CLI:
2832
dotnet add package TALib.NETCore
2933
```
3034

35+
## Documentation
36+
37+
Read the [DOCS](https://hmG3.github.io/TA-Lib.NETCore) for more information on how to use the library.
38+
3139
## References
3240

3341
- [Homepage of TA-Lib](https://ta-lib.org/)

0 commit comments

Comments
 (0)