From ba0716968bd6db541f82b37b6e864165900bb289 Mon Sep 17 00:00:00 2001 From: Dave Skender <8432125+DaveSkender@users.noreply.github.com> Date: Fri, 24 Mar 2023 00:48:00 -0400 Subject: [PATCH] chore: update docs (#1036) * add preview label to stream example * update guide * update packages, badges --- docs/GemFile.lock | 6 +++--- docs/examples/README.md | 2 +- docs/guide.md | 2 +- docs/home.md | 20 +++++++++++++++----- 4 files changed, 20 insertions(+), 10 deletions(-) diff --git a/docs/GemFile.lock b/docs/GemFile.lock index cb812d2a6..9bfae0ad7 100644 --- a/docs/GemFile.lock +++ b/docs/GemFile.lock @@ -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) @@ -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) @@ -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) diff --git a/docs/examples/README.md b/docs/examples/README.md index 41fc9bb53..6aa47256d 100644 --- a/docs/examples/README.md +++ b/docs/examples/README.md @@ -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). diff --git a/docs/guide.md b/docs/guide.md index 1432067a6..4f3220938 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -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 diff --git a/docs/home.md b/docs/home.md index 9ef992f18..7a21943b1 100644 --- a/docs/home.md +++ b/docs/home.md @@ -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 ---

{{ page.title }}

-NuGet package badge -Package downloads badge -Test code coverage badge + + + + + + + + + **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.