-
-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: adds the basic import documentation
- Loading branch information
Bolorunduro Winner-Timothy B
committed
Jun 12, 2017
1 parent
31f9307
commit cb7dea2
Showing
1 changed file
with
20 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,23 @@ | ||
# shortid | ||
|
||
[![Build Status](https://travis-ci.org/bolorundurowb/shortid.svg?branch=master)](https://travis-ci.org/bolorundurowb/shortid) | ||
[![Build Status](https://travis-ci.org/bolorundurowb/shortid.svg?branch=master)](https://travis-ci.org/bolorundurowb/shortid) [![NuGet Badge](https://buildstats.info/nuget/shortid)](https://www.nuget.org/packages/shortid) | ||
|
||
## About ShortId | ||
|
||
A csharp library to generate short id's. they can be used as primary keys or unique identifiers. | ||
|
||
## How to use | ||
To make use of the `shortid`, add it to your project via the Nuget package manager UI or console via this command: | ||
|
||
``` | ||
Install-Package shortid | ||
``` | ||
|
||
Add the following using command to the top of your csharp code file: | ||
|
||
```csharp | ||
using shortid; | ||
``` | ||
|
||
This gives your code access the classes and methods of the `shortid` namespace. | ||
|
||
A csharp library to generate short id's. they can be used as primary keys or unique identifiers |