Skip to content

Commit

Permalink
Updated readme for NuGet release
Browse files Browse the repository at this point in the history
  • Loading branch information
pyrocumulus committed Feb 27, 2020
1 parent 360662c commit 0113b56
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 11 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
# PVOutput.Net

![.NET Core](https://github.com/pyrocumulus/pvoutput.net/workflows/.NET%20Core/badge.svg)
> A .NET wrapper library for API of the popular [PVOutput](https://pvoutput.org) service.
> PVOutput is a free service for sharing and comparing PV output data.
> A .NET wrapper library for the [PVOutput api](https://pvoutput.org/help.html#api-spec).
![.NET Core](https://github.com/pyrocumulus/pvoutput.net/workflows/.NET%20Core/badge.svg)
[![NuGet Badge](https://buildstats.info/nuget/PVOutput.Net)](https://www.nuget.org/packages/PVOutput.Net/)

## Install

Nuget package will come when the implementation reaches a usable version. A version that's getting the basic information out of PVOutput and is able to push basic data back to PVOutput, is regarded as usable.
The project will adhere to [Semver](https://semver.org/) for versioning. Version 1.x will take a good amount of time, because for that there needs to be stability in the API and 100% API coverage.
Installation can be done through installation of the [NuGet package](https://www.nuget.org/packages/PVOutput.Net/).

## Usage

For now sample code can be found in the samples/folder of the project. Documentation will come eventually.
For now sample code can be found in the samples/folder of the project. Full API documentation will come soon.

## API Coverage

Currently all read operations of the API are implemented as are all of the operations for adding data.

| Operation | Object | (Expected) Module | Status | Documentation link |
| Operation | Object | Module | Status | Documentation link |
|------------|--------------|-------------------|--------------------|-------------------------|
| Add | Output | Output | :heavy_check_mark: | [Add Output](https://pvoutput.org/help.html#api-addoutput) |
| Add | Batch Output | Output | :heavy_check_mark: | [Add Batch Output](https://pvoutput.org/help.html#api-addbatchoutput) |
Expand Down Expand Up @@ -49,7 +50,7 @@ As the whole solution has all that dotnet magic, you can just run:
dotnet build
```

to build the solution or a single project.
to build the solution or a single project.

For unit testing, just run:

Expand All @@ -59,7 +60,7 @@ dotnet test

## Contribute

As the code base is still changing a lot, PRs will probably be more practical, benefical and succesful after things have settled down a bit. But you can try.
The project adheres to [Semver 2.0](https://semver.org/) for versioning. As the code base is still changing a lot, PRs will probably be more practical, benefical and succesful after things have settled down a bit. But you can try.

## License

Expand Down
13 changes: 10 additions & 3 deletions src/PVOutput.Net/PVOutput.Net.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,32 @@
<GeneratePackageOnBuild>false</GeneratePackageOnBuild>
<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
<Authors>Marcel Boersma</Authors>
<Version>0.5.0-alpha</Version>
<Version>0.5.0</Version>
<Copyright></Copyright>
<PackageLicenseFile>LICENSE</PackageLicenseFile>
<PackageProjectUrl>https://github.com/pyrocumulus/pvoutput.net</PackageProjectUrl>
<RepositoryUrl>https://github.com/pyrocumulus/pvoutput.net</RepositoryUrl>
<PackageTags>dotnet, solar, pvoutput</PackageTags>
<PackageTags>dotnet, solar, pvoutput, api</PackageTags>
<Title>PVOutput.Net</Title>
<Description>A .NET library built around the API of the popular website PVOutput.net.</Description>
<Description>A .NET wrapper library built around the API of the popular service PVOutput.org.</Description>
<Company />
<IncludeSymbols>true</IncludeSymbols>
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<PackageReleaseNotes>Initial release for NuGet.</PackageReleaseNotes>
<PackageId>PVOutput.Net</PackageId>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<OutputPath>..\..\artifacts\</OutputPath>
<DocumentationFile>..\..\artifacts\$(AssemblyName).xml</DocumentationFile>
</PropertyGroup>

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
<OutputPath>..\..\artifacts\release\</OutputPath>
<DocumentationFile>..\..\artifacts\release\$(AssemblyName).xml</DocumentationFile>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.8">
<PrivateAssets>all</PrivateAssets>
Expand Down

0 comments on commit 0113b56

Please sign in to comment.