diff --git a/README.md b/README.md index 07c1ac5..86cbd42 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +![nuget badge](https://img.shields.io/nuget/v/AjsWebDesign.DVSA.MOT.SDK) # DVSA.MOT.SDK A simple SDK for access to the [DVSA MOT history API](https://dvsa.github.io/mot-history-api-documentation/) @@ -6,7 +7,7 @@ A simple SDK for access to the [DVSA MOT history API](https://dvsa.github.io/mot To be able to use this SDK, you will require an Api Key, which you can apply for from the [DVSA](https://www.smartsurvey.co.uk/s/MOT_History_TradeAPI_Access_and_Support?). -DVSA.MOT.SDK is available from [NuGet](#) or as a manual download directly from GitHub. +DVSA.MOT.SDK is available from [NuGet](https://www.nuget.org/packages/AjsWebDesign.DVSA.MOT.SDK) or as a manual download directly from GitHub. ## Usage @@ -24,6 +25,11 @@ Then you will then need to register the apikey and SDK in your `Startup.cs` file services.AddDvlaMotSdk(); +### Documentation + +Documentation and examples on how the parameters are used to access the api can be found on the dvsa api history website: +[https://dvsa.github.io/mot-history-api-documentation/](https://dvsa.github.io/mot-history-api-documentation/) + ### Contribution guidelines To raise a new bug, create an issue on the GitHub repository. To fix a bug or add new features, fork the repository and send a pull request with your changes. Feel free to add ideas to the repository's issues list if you would to discuss anything related to the package.