An open API service indexing awesome lists of open source software.

https://github.com/jonsagara/crockford-base32-core

.NET Standard version of the crockford-base32 library formerly available on CodePlex.
https://github.com/jonsagara/crockford-base32-core

base32 crockford crockford-base32

Last synced: 5 months ago
JSON representation

.NET Standard version of the crockford-base32 library formerly available on CodePlex.

Awesome Lists containing this project

README

          

## How do I install this library?

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

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

## What is it?

A repackaging of the [original crockford-base32 nuget package](https://www.nuget.org/packages/crockford-base32) to support `netstandard2.0` and `netstandard2.1`.

## Why does it exist?

The original crockford-base32 nuget package does not support `.NET Core` or `.NET Standard`.

## What changes did you make?

* Targeted `netstandard2.0` and `netstandard2.1`
* Migrated the unit tests to use `xUnit`

## How do I build it?

### Visual Studio 2019

Open `CrockfordBase32.sln` and compile.

### FAKE

* Ensure you have [.NET Core SDK 3.1.300](https://dotnet.microsoft.com/download) 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

**Only installable via NuGet: http://nuget.org/List/Packages/crockford-base32** (You all use NuGet by now, right?)

Great for building hashes into URLs.

Resilient to humans:

* No crazy characters or keyboard gymnastics
* Totally case insensitive
* 0, O and o all decode to the same thing
* 1, I, i, L and l all decode to the same thing
* Doesn’t use U, so 519,571 encodes to FVCK instead
* Optional check digit on the end

Handles any ulong from 0 all the way through to 18,446,744,073,709,551,615.

**Number** | **Encoded** | **Encoded with optional check digit**
--- | --- | ---
1 | 1 | 11
194 | 62 |629
456,789 | 1CKE |1CKEM
398,373 | C515 | C515Z
3,838,385,658,376,483 | 3D2ZQ6TVC93 | 3D2ZQ6TVC935
18,446,744,073,709,551,615 | FZZZZZZZZZZZZ | FZZZZZZZZZZZZB