Skip to content
This repository has been archived by the owner on Feb 25, 2023. It is now read-only.

Commit

Permalink
Updated the readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
jonsagara committed Aug 1, 2018
1 parent b5908e1 commit 9a5f883
Showing 1 changed file with 39 additions and 3 deletions.
42 changes: 39 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,42 @@
> **2018-07-12**: Imported from https://archive.codeplex.com/?p=crockfordbase32 and modernized.
>
> Original repository description follows.
## What is this?

A repackaging of the old [crockford-base32](https://www.nuget.org/packages/crockford-base32) nuget package to support `.NET Standard 1.3`.

## Why does it exist?

The [crockford-base32](https://www.nuget.org/packages/crockford-base32) nuget package does not support `.NET Core` or `.NET Standard`.

## What changes did you make?

* Targeted `.NET Standard 1.3`
* Migrated the unit tests to use `xUnit`

## How do I use it?

Install the [crockford-base32-core](https://www.nuget.org/packages/crockford-base32-core/) package via nuget:

```
Install-Package crockford-base32-core -Version 1.1.0
```

## How do I build it?

### Visual Studio 2017

Open `CrockfordBase32.sln` and compile.

### FAKE

* Ensure you have [.NET Core SDK 2.1.302](https://www.microsoft.com/net/download/dotnet-core/2.1) or higher installed
* Ensure you have [FAKE](https://fake.build/) installed:

```
dotnet tool install fake-cli -g
```
* From the root directory on the command line, run `fake build`


## The original README follows:

A .NET encoder/decoder implementation of http://www.crockford.com/wrmg/base32.html

Expand Down

0 comments on commit 9a5f883

Please sign in to comment.