Skip to content

Commit

Permalink
doc: adds the basic import documentation
Browse files Browse the repository at this point in the history
  • 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.
22 changes: 20 additions & 2 deletions README.md
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

0 comments on commit cb7dea2

Please sign in to comment.