Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rm-hull/base58

Base58 and check algorithm that is compatible with what is used by the bitcoin network, in Clojure.
https://github.com/rm-hull/base58

Last synced: about 1 month ago
JSON representation

Base58 and check algorithm that is compatible with what is used by the bitcoin network, in Clojure.

Awesome Lists containing this project

README

        

# Base58 [![Build Status](https://travis-ci.org/rm-hull/base58.svg?branch=master)](http://travis-ci.org/rm-hull/base58) [![Coverage Status](https://coveralls.io/repos/rm-hull/base58/badge.svg?branch=master)](https://coveralls.io/r/rm-hull/base58?branch=master) [![Dependencies Status](https://jarkeeper.com/rm-hull/base58/status.svg)](https://jarkeeper.com/rm-hull/base58) [![Downloads](https://jarkeeper.com/rm-hull/base58/downloads.svg)](https://jarkeeper.com/rm-hull/base58) [![Clojars Project](https://img.shields.io/clojars/v/rm-hull/base58.svg)](https://clojars.org/rm-hull/base58)

A small clojure library implementing Base58 and Base58Check algorithms compatible
with what is used by the bitcoin network.

### Pre-requisites

You will need [Leiningen](https://github.com/technomancy/leiningen) 2.6.1 or above installed.

### Building

To build and install the library locally, run:

$ cd base58
$ lein test
$ lein install

### Including in your project

There is a version hosted at [Clojars](https://clojars.org/rm-hull/base58).
For leiningen include a dependency:

```clojure
[rm-hull/base58 "0.1.0"]
```

For maven-based projects, add the following to your `pom.xml`:

```xml

rm-hull
base58
0.1.0

```

## API Documentation

See [www.destructuring-bind.org/base58](http://www.destructuring-bind.org/base58/) for API details.

## Basic Usage

> TODO

## Attribution

* Clojure port of https://github.com/keis/base58, all rights of the original authors reserved.

## License

### The MIT License (MIT)

Copyright (c) 2016 Richard Hull

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.