Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hassie-dash authored Jan 16, 2018
1 parent b81dbac commit 5a62250
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
NewsAPI.NET
===========
NewsAPI.NET is a asynchronous API wrapper around News API. It is based on their new v2 API and is a work in progress. At the moment, only the top headlines endpoint has been implemented.
It is written in NET Standard 1.1.

NuGet
-----
This library is available on NuGet, under the package name Hassie.NET.API.NewsAPI. The current version is 1.0.1.

Example usage
-------------
```cs
INewsClient newsClient = new ClientBuilder()
{
ApiKey = "Your API Key";
};
INewsArticles articles = await newsClient.GetTopHeadlines(Category.TECHNOLOGY, Country.GB);
INewsArticle article = articles.Articles.ElementAt(4);
Console.WriteLine(article.Author);
Console.WriteLine(article.Description);
Console.WriteLine(article.ImageURL);
Console.WriteLine(article.PublishTime);
Console.WriteLine(article.SourceName);
Console.WriteLine(article.Title);
Console.WriteLine(article.URL);
```

License
-------
Copyright ©2018 Hassie.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

0 comments on commit 5a62250

Please sign in to comment.