From 8c2655b0e3830414aae4e8df0d08c92d3d810611 Mon Sep 17 00:00:00 2001 From: Alan Doherty Date: Thu, 12 Jul 2018 17:25:54 +0100 Subject: [PATCH] Improved readme --- README.md | 31 +++++++++++++++++++++++++++- src/WifiPlug.Api/WifiPlug.Api.csproj | 4 +++- 2 files changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 01a0b6c..30e3d53 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,32 @@ -# WifiPlug.Api +
+ +[![GitHub license](https://img.shields.io/badge/license-Apache%202-blue.svg?style=flat-square)](https://raw.githubusercontent.com/wifiplug/api-client-net/master/README.md) +[![GitHub issues](https://img.shields.io/github/issues/wifiplug/api-client-net.svg?style=flat-square)](https://github.com/wifiplug/api-client-net/issues) +[![GitHub stars](https://img.shields.io/github/stars/wifiplug/api-client-net.svg?style=flat-square)](https://github.com/wifiplug/api-client-net/stargazers) +[![GitHub forks](https://img.shields.io/github/forks/wifiplug/api-client-net.svg?style=flat-square)](https://github.com/wifiplug/api-client-net/network) + +
+ +# WifiPlug API The .NET API client for the WIFIPLUG platform. +## Get Started + +[![NuGet Status](https://img.shields.io/nuget/v/WifiPlug.Api.svg?style=flat)](https://www.nuget.org/packages/WifiPlug.Api/) + +You can install the package using either the CLI: + +``` +dotnet add package WifiPlug.Api +``` + +or from the NuGet package manager: + +``` +Install-Package WifiPlug.Api +``` + ## Example An example of using the API asynchronously. @@ -32,3 +57,7 @@ class Program } } ``` + +## Contributing + +We welcome any pull requests or bug reports, please try and keep to the existing style conventions and comment any additions. The issues section is only for problems related to the API client, other issues will be closed. \ No newline at end of file diff --git a/src/WifiPlug.Api/WifiPlug.Api.csproj b/src/WifiPlug.Api/WifiPlug.Api.csproj index 90fc5e3..d1bca48 100644 --- a/src/WifiPlug.Api/WifiPlug.Api.csproj +++ b/src/WifiPlug.Api/WifiPlug.Api.csproj @@ -13,7 +13,9 @@ git 0.1.0.0 0.1.0.0 - false + true + + https://github.com/wifiplug/api-client-net/blob/master/LICENSE