Skip to content

Commit

Permalink
#36 Updated README (#84)
Browse files Browse the repository at this point in the history
* Updated README

* fixed typo
  • Loading branch information
Rabeb Othmani authored and smithrobs committed Feb 18, 2018
1 parent e2710e6 commit 94e81ae
Showing 1 changed file with 30 additions and 7 deletions.
37 changes: 30 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ Nexmo Client Library for C#/.NET
[![](http://img.shields.io/nuget/v/Nexmo.Csharp.Client.svg?style=flat-square)](http://www.nuget.org/packages/Nexmo.Csharp.Client)
[![](http://img.shields.io/nuget/vpre/Nexmo.Csharp.Client.svg?style=flat-square)](http://www.nuget.org/packages/Nexmo.Csharp.Client)

## THIS IS THE 3.0 RELEASE BRANCH. It is a work in progress. This documentation is currently outdated. Please look at the [3.0 milestones](https://github.com/Nexmo/nexmo-dotnet/milestone/3) for more info.

You can use this C# client library to integrate [Nexmo's APIs](#api-coverage) to your application. To use this, you'll
need a Nexmo account. Sign up [for free at nexmo.com][signup].
Expand Down Expand Up @@ -34,6 +33,14 @@ Alternatively:
either including them with your project's NuGet dependencies or manually referencing them.
* Reference the assembly in your code.

Targeted frameworks:
--------------

* 4.5.2
* 4.6, 4.6.1, 4.6.2
* .NET Standard 1.6, 2.0
* ASP.NET Core 2.0

Configuration:
--------------
* Provide the nexmo URLs, API key, secret, and application credentials (for JWT) in ```appsettings.json```:
Expand All @@ -58,6 +65,28 @@ Configuration:
* ```appsettings.json``` which overrides
* ```settings.json```

Alternatively:
* Provide the credentials as part of the API call.

```csharp
var creds = new Nexmo.Api.Request.Credentials
{
ApiKey = NEXMO_API_KEY,
ApiSecret = NEXMO_API_SECRET,
ApplicationId = NEXMO_APPLICATION_ID,
ApplicationKey = NEXMO_APPLICATION_KEY
};
```

```csharp
var results = SMS.Send(new SMS.SMSRequest
{
from = "15555551212",
to = "17775551212",
text = "this is a test"
}, creds);
```

### Configuration Reference

Key | Description
Expand Down Expand Up @@ -300,12 +329,6 @@ API Coverage
Contributing
------------

Targeted frameworks:

* 4.5.2
* 4.6, 4.6.1, 4.6.2
* .NET Standard 1.6, 2.0

Visual Studio 2017 is required (Community is fine). v15.3.5 is recommended.

1. Get latest code either by cloning the repository or downloading a snapshot of the source.
Expand Down

0 comments on commit 94e81ae

Please sign in to comment.