Skip to content

Commit

Permalink
chore: update docs (#1036)
Browse files Browse the repository at this point in the history
* add preview label to stream example
* update guide
* update packages, badges
  • Loading branch information
DaveSkender authored Mar 24, 2023
1 parent ba28312 commit ba07169
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 10 deletions.
6 changes: 3 additions & 3 deletions docs/GemFile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ GIT
GEM
remote: https://rubygems.org/
specs:
activesupport (7.0.4.2)
activesupport (7.0.4.3)
concurrent-ruby (~> 1.0, >= 1.0.2)
i18n (>= 1.6, < 2)
minitest (>= 5.1)
Expand All @@ -34,7 +34,7 @@ GEM
faraday-net_http (>= 2.0, < 3.1)
ruby2_keywords (>= 0.0.4)
faraday-net_http (3.0.2)
faraday-retry (2.0.0)
faraday-retry (2.1.0)
faraday (~> 2.0)
ffi (1.15.5)
ffi (1.15.5-x64-mingw-ucrt)
Expand Down Expand Up @@ -221,7 +221,7 @@ GEM
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.17.0)
minitest (5.18.0)
nokogiri (1.14.2-x64-mingw-ucrt)
racc (~> 1.4)
nokogiri (1.14.2-x86_64-linux)
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To help you get started, here are a few minimalist .NET 7.0 C# projects that you
- `Backtest` is a slightly more complicated example of how to analyze results
- `CustomIndicatorsLibrary` shows how you can [create your own custom indicators]({{site.baseurl}}/custom-indicators/#content)
- `CustomIndicatorsUsage` shows how you'd use a custom indicator just like any other in the main library
- `ObserveStream` shows how you'd use live quotes from WebSocket, using the Alpaca SDK for .NET
- `ObserveStream` [preview] shows how you'd use live quotes from WebSocket, using the Alpaca SDK for .NET
- `UseQuoteApi` shows how you'd get quotes from an API quote source, using the Alpaca SDK for .NET

For more information on how to use this library overall, see the [Guide and Pro Tips]({{site.baseurl}}/guide/#content).
Expand Down
2 changes: 1 addition & 1 deletion docs/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ layout: page

### Installation and setup

Find and install the [Skender.Stock.Indicators](https://www.nuget.org/packages/Skender.Stock.Indicators) NuGet package into your Project. See [more help](https://www.google.com/search?q=install+nuget+package) for installing packages.
Find and install the [Skender.Stock.Indicators](https://www.nuget.org/packages/Skender.Stock.Indicators) NuGet package into your Project. See more [help for installing packages](https://www.google.com/search?q=install+nuget+package).

```powershell
# dotnet CLI example
Expand Down
20 changes: 15 additions & 5 deletions docs/home.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,26 @@
---
title: Stock Indicators for .NET
description: "Transform financial market prices into technical analysis insights with this best in class C# NuGet library. Go further
with chaining and custom indicators."
description: >-
Transform financial market prices into technical analysis insights with this best in class C# NuGet library.
Go further with chaining and custom indicators.
permalink: /
layout: base
---

<h1>{{ page.title }}</h1>

<a href="https://www.nuget.org/packages/Skender.Stock.Indicators"><img src="https://img.shields.io/nuget/v/skender.stock.indicators?color=blue&logo=NuGet&label=NuGet%20Package" alt="NuGet package badge" width="155" height="20" /></a>
<a href="https://www.nuget.org/packages/Skender.Stock.Indicators"><img src="https://img.shields.io/nuget/dt/skender.stock.indicators?logo=NuGet&label=Downloads" alt="Package downloads badge" width="125" height="20" /></a>
<a href="https://dev.azure.com/skender/Stock.Indicators/_build/latest?definitionId=21&branchName=main&view=codecoverage-tab"><img src="https://img.shields.io/azure-devops/coverage/skender/stock.indicators/21/main?logo=AzureDevOps&label=Test%20Coverage" alt="Test code coverage badge" width="149" height="20" /></a>
<a href="https://www.nuget.org/packages/Skender.Stock.Indicators">
<img src="https://img.shields.io/nuget/v/skender.stock.indicators?color=blue&logo=NuGet&label=NuGet%20Package"
alt max-width="160" height="20" />
</a>
<a href="https://www.nuget.org/packages/Skender.Stock.Indicators">
<img src="https://img.shields.io/nuget/dt/skender.stock.indicators?logo=NuGet&label=Downloads"
alt max-width="130" height="20" />
</a>
<a href="https://dev.azure.com/skender/Stock.Indicators/_build/latest?definitionId=21&branchName=main&view=codecoverage-tab">
<img src="https://img.shields.io/azure-devops/coverage/skender/stock.indicators/21/main?logo=AzureDevOps&label=Test%20Coverage"
alt max-width="155" height="20" />
</a>

**Stock Indicators for .NET** is a C# [library package](https://www.nuget.org/packages/Skender.Stock.Indicators) that produces financial market technical indicators. Send in historical price quotes and get back desired indicators such as moving averages, Relative Strength Index, Stochastic Oscillator, Parabolic SAR, etc. Nothing more.

Expand Down

0 comments on commit ba07169

Please sign in to comment.