feat: Update README.md with instructions (#6)

2022-06-15 17:26:07 +03:00
parent e91f1670b5
commit 94323dae6f
1 changed files with 55 additions and 1 deletions
@@ -1 +1,55 @@
-# NordigenDotNet
+[![Nuget](https://img.shields.io/nuget/v/VMelnalksnis.NordigenDotNet?label=NordigenDotNet)](https://www.nuget.org/packages/VMelnalksnis.NordigenDotNet/)
+[![Nuget](https://img.shields.io/nuget/v/VMelnalksnis.NordigenDotNet.DependencyInjection?label=NordigenDotNet.DependencyInjection)](https://www.nuget.org/packages/VMelnalksnis.NordigenDotNet.DependencyInjection/)
+[![Codecov](https://img.shields.io/codecov/c/github/VMelnalksnis/NordigenDotNet)](https://app.codecov.io/gh/VMelnalksnis/NordigenDotNet)
+
+# NordigenDotNet
+.NET client for the [Nordigen](https://nordigen.com/en/) API.
+
+# Usage
+
+A separate [NuGet package](https://www.nuget.org/packages/VMelnalksnis.NordigenDotNet.DependencyInjection/)
+is provided for ASP.NET Core
+([IConfiguration](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.configuration.iconfiguration)
+and [IServiceCollection](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection))
+.
+For use outside of ASP.NET Core, see the
+[configuration](source/VMelnalksnis.NordigenDotNet.DependencyInjection/ServiceCollectionExtensions.cs).
+
+1. Add configuration
+
+```yaml
+"Nordigen": {
+    "BaseAddress": "https://ob.nordigen.com/",
+    "SecretId": "",
+    "SecretKey": ""
+}
+```
+
+2. Register required services
+
+```csharp
+// Only registers services from NordigenDotNet
+services.AddNordigenDotNet(Configuration);
+// Also registers the IDateTimeZoneProvider, which is required
+serviceCollection.AddNordigenDotNet(Configuration, DateTimeZoneProviders.Tzdb);
+```
+
+3. (Optional) Configure retries
+   with [Polly](https://github.com/App-vNext/Polly) ([NuGet package](https://www.nuget.org/packages/Microsoft.Extensions.Http.Polly))
+
+```csharp
+services
+	.AddNordigenDotNet(Configuration, DateTimeZoneProviders.Tzdb)
+	.AddPolicyHandler(...);
+```
+
+4. Use `INordigenClient` to access all endpoints, or one of the specific clients defined in `INordigenClient`
+
+# Known issues
+
+1. Does not support the
+   [premium endpoints](https://nordigen.com/en/docs/account-information/integration/parameters-and-responses/#/premium)
+2. Due to incomplete documentation and differences between data returned by each bank,
+   not all data returned by the Nordigen API might be captured.
+   When using the client with a new institution, consider inspecting the raw data returned by Nordigen.
+   If something is missing, please [create an issue](https://github.com/VMelnalksnis/NordigenDotNet/issues/new)