From 258e646348de7b7a23a04a83c2d243d84645cd15 Mon Sep 17 00:00:00 2001 From: Marcel <1721382+pyrocumulus@users.noreply.github.com> Date: Tue, 26 Jul 2022 09:39:18 +0200 Subject: [PATCH 1/2] Fix README formatting for NuGet compatibility Fixes #125 --- README.md | 20 ++++++-------------- docfx/index.md | 2 +- 2 files changed, 7 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 5ed0743..6495e88 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,6 @@ ![GitHub last commit (master)](https://img.shields.io/github/last-commit/pyrocumulus/PVOutput.Net/master?label=last%20commit%20%28master%29) [![NuGet Version](https://img.shields.io/nuget/v/PVOutput.Net.svg?logo=nuget)](https://www.nuget.org/packages/PVOutput.Net/) [![NuGet Downloads](https://img.shields.io/nuget/dt/PVOutput.Net.svg?logo=nuget)](https://www.nuget.org/packages/PVOutput.Net/) -[![fuget](https://www.fuget.org/packages/PVOutput.Net/badge.svg)](https://www.fuget.org/packages/PVOutput.Net) [![.NET Core](https://img.shields.io/github/workflow/status/pyrocumulus/PVOutput.Net/.NET%20Core/develop)](https://github.com/pyrocumulus/pvoutput.net/actions?query=workflow%3A%22.NET+Core%22) [![Code coverage](https://img.shields.io/codecov/c/github/pyrocumulus/PVOutput.Net/develop)](https://codecov.io/gh/pyrocumulus/pvoutput.net) @@ -31,8 +30,9 @@ See [master](https://github.com/pyrocumulus/pvoutput.net/tree/master) for the so ## Basic usage -
- Getting data out of PVOutput.org +This section describes examples of functionality that the library provides. + +### Getting data out of PVOutput.org ```csharp var client = new PVOutputClient(apiKey: "myPvOutputKey", ownedSystemId: 1); @@ -44,10 +44,7 @@ Console.WriteLine($"Output for date {output.OutputDate.ToShortDateString()}, {ou ``` -
- -
- Adding data to a system in PVOutput.org +### Adding data to a system in PVOutput.org ```csharp var client = new PVOutputClient(apiKey: "myPvOutputKey", ownedSystemId: 1); @@ -55,7 +52,7 @@ var builder = new StatusPostBuilder(); // Build the status var status = builder.SetTimeStamp(DateTime.Now) - .SetGeneration(200, null) + .SetGeneration(200) .Build(); // Push the status back to PVOutput @@ -63,10 +60,7 @@ var response = await client.Status.AddStatusAsync(status); ``` -
- -
- Using the client in an ASP.Net Core application +### Using the client in an ASP.Net Core application ```csharp public void ConfigureServices(IServiceCollection services) @@ -79,8 +73,6 @@ var response = await client.Status.AddStatusAsync(status); } ``` -
- For more information on usage, please see the [documentation](https://pyrocumulus.github.io/pvoutput.net/). ## API Coverage diff --git a/docfx/index.md b/docfx/index.md index 1251b25..c7de896 100644 --- a/docfx/index.md +++ b/docfx/index.md @@ -43,7 +43,7 @@ var builder = new StatusPostBuilder(); // Build the status var status = builder.SetTimeStamp(DateTime.Now) - .SetGeneration(200, null) + .SetGeneration(200) .Build(); // Push the status back to PVOutput From 16758bad06c4dcb3472e215b1641ae85dfcdf6f8 Mon Sep 17 00:00:00 2001 From: Marcel <1721382+pyrocumulus@users.noreply.github.com> Date: Tue, 26 Jul 2022 22:17:40 +0200 Subject: [PATCH 2/2] Update CHANGELOG.md --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index f97aaf6..470a82b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). +## Unreleased + +### Fixed + +- Updated all links to official API documentation [#133](https://github.com/pyrocumulus/pvoutput.net/pull/133) + ## [0.11.1] - 2022-07-24 ### Fixed