Skip to content
This repository was archived by the owner on May 8, 2020. It is now read-only.

Commit fc329ba

Browse files
reverentgeekreverentgeek
committed
Adding NuGet package specs and updated README
1 parent 2ae128d commit fc329ba

3 files changed

Lines changed: 36 additions & 5 deletions

File tree

‎LeanKit.API.Client.Library/Properties/AssemblyInfo.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
// associated with an assembly.
1313

1414
[assembly: AssemblyTitle("LeanKit.API.Client.Library")]
15-
[assembly: AssemblyDescription("")]
15+
[assembly: AssemblyDescription("LeanKit API client wrapper for .NET")]
1616
[assembly: AssemblyConfiguration("")]
1717
[assembly: AssemblyCompany("LeanKit Inc.")]
1818
[assembly: AssemblyProduct("LeanKit.API.Client.Library")]

‎README.md‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ The **LeanKit.API.Client.Library** namespace provides a wrapper library designed
44

55
This library exposes two primary ways to interact with LeanKit. These are the LeanKitClient and LeanKitIntegration classes. Both of these are explained below.
66

7+
## Installing with NuGet
8+
9+
NuGet is a Visual Studio extension that makes it easy to add, remove, and update libraries and tools in Visual Studio projects that use the .NET Framework. To learn more about NuGet, read the [documentation](http://docs.nuget.org).
10+
11+
To install the [LeanKit API Client](https://www.nuget.org/packages/LeanKit.API.Client) using NuGet, search for "LeanKit" in the Visual Studio NuGet Package Manager, or install directly using the Package Manager Console:
12+
13+
```
14+
PM> Install-Package LeanKit.API.Client
15+
```
16+
717
## LeanKitClient
818

919
This class exposes methods that interact directly with LeanKit API. This class exposes the same methods exposed through the REST API, but hides the complexity of working with HTTP and JSON. This class allows you to send commands and queries to LeanKit using strongly-typed native objects. This class should be used if you are building a simple, stateless integration where you are not interested in interacting with a LeanKit Board over a period of time. This class should also be used if you cannot support a long-running service or process.
@@ -22,7 +32,7 @@ var api = new LeanKitClientFactory().Create(leanKitAuth);
2232

2333
## LeanKitIntegration
2434

25-
This class is designed to be used in stateful implementations. This class monitors the changes to a Board, and raises events whenever a board is changed. This library helps reduce the complexity of polling for changes. In addition, this class exposes the same command and query methods that are available in the LeanKitClient class. Leveraging its stateful nature, many of these queries and commands can be optimized, and provide more powerful validation.
35+
This class is designed to be used in stateful implementations. This class monitors the changes to a Board, and raises events whenever a board is changed. This library helps reduce the complexity of polling for changes. In addition, this class exposes the same command and query methods that are available in the LeanKitClient class. Leveraging its stateful nature, many of these queries and commands can be optimized, and provide more powerful validation.
2636

2737
This class is designed to retrieve and hold a reference to the board, and therefore should not be instantiated numerous times. Each instance will be associated to a single LeanKit Board. You will need to create an instance for each Board you wish to interact with.
2838

@@ -39,7 +49,7 @@ var leanKitAuth = new LeanKitAccountAuth
3949
// Use the board ID (number) of the board you wish to monitor
4050
// This ID can be found in the URL when you visit your LeanKit board
4151
// https://accountname.leankit.com/Boards/View/101
42-
var boardId = 101;
52+
var boardId = 101;
4353
4454
var integration = new LeanKitIntegrationFactory().Create(boardId, leanKitAuth);
4555
integration.BoardChanged += integration_BoardChanged;
@@ -75,7 +85,7 @@ BoardUpdates CheckForUpdates(long boardId, int version);
7585
IEnumerable<Comment> GetComments(long boardId, long cardId);
7686
int PostComment(long boardId, long cardId, Comment comment);
7787
IEnumerable<CardEvent> GetCardHistory(long boardId, long cardId);
78-
IEnumerable<CardView> SearchCards(long boardId, SearchOptions options);
88+
IEnumerable<CardView> SearchCards(long boardId, SearchOptions options);
7989
IEnumerable<Asset> GetAttachments(long boardId, long cardId);
8090
Asset GetAttachment(long boardId, long cardId, long attachmentId);
8191
long SaveAttachment(long boardId, long cardId, string fileName, string description, string mimeType, byte[] fileBytes);
@@ -148,4 +158,4 @@ Copyright &copy; 2013-2014 LeanKit Inc.
148158

149159
## License
150160

151-
LeanKit Integration Service is licensed under [MIT](http://www.opensource.org/licenses/mit-license.php). Refer to license.txt for more information.
161+
LeanKit Integration Service is licensed under [MIT](http://www.opensource.org/licenses/mit-license.php). Refer to license.txt for more information.

‎publish/LeanKit.API.Client.Library.dll.nuspec‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<?xml version="1.0"?>
2+
<package>
3+
<metadata>
4+
<id>LeanKit.API.Client</id>
5+
<version>1.0.1</version>
6+
<authors>LeanKit</authors>
7+
<owners>LeanKit</owners>
8+
<licenseUrl>https://raw.githubusercontent.com/LeanKit/LeanKit.API.Client/master/License.txt</licenseUrl>
9+
<projectUrl>https://github.com/LeanKit/LeanKit.API.Client</projectUrl>
10+
<iconUrl>https://raw.githubusercontent.com/LeanKit/LeanKit.API.Client/master/leankit-64x64.ico</iconUrl>
11+
<requireLicenseAcceptance>false</requireLicenseAcceptance>
12+
<description>LeanKit API Client wrapper for .NET</description>
13+
<releaseNotes></releaseNotes>
14+
<copyright>Copyright 2014 LeanKit</copyright>
15+
<tags></tags>
16+
<dependencies>
17+
<dependency id="Newtonsoft.Json" version="6.0.3" />
18+
<dependency id="RestSharp" version="104.4.0" />
19+
</dependencies>
20+
</metadata>
21+
</package>

0 commit comments

Comments
 (0)