mxbit/README.md

Bitcoin cash bike-shed

# Mxbit

[![CircleCi Status][circleci-status-img]][circleci-status-url]
[![Coverage Status][coverage-status-img]][coverage-status-url]

**Mxbit** is an alternative implementation of the bitcoin cash protocol,
written in node.js.

Mxbit is undergoing development and testing and is in alpha stage. Mxbit
is a fork of [bcoin][bcoin] and has the same RPC API.

## Uses

- Full Node
- SPV Node
- Wallet Backend (bip44 derivation)
- Mining Backend (getblocktemplate support)
- General Purpose Bitcoin Library

Try it in the browser: https://bcoin.io/browser/

## Install

```
$ git clone git://github.com/bcoin-org/mxbit.git
$ cd mxbit
$ npm install
$ ./bin/mxbit
```

See the [Beginner's Guide][guide] for more in-depth installation instructions.

## Documentation

- API Docs: https://bcoin.io/docs/
- REST Docs: https://bcoin.io/api-docs/
- Docs: [docs/](docs/README.md)

## Support

Join us on [freenode][freenode] in the [#bcoin][irc] channel.

## Disclaimer

Mxbit does not guarantee you against theft or lost funds due to bugs, mishaps,
or your own incompetence. You and you alone are responsible for securing your
money.

## Contribution and License Agreement

If you contribute code to this project, you are implicitly allowing your code
to be distributed under the MIT license. You are also implicitly verifying that
all code is your original work. `</legalese>`

## License

- Copyright (c) 2014-2015, Fedor Indutny (MIT License).
- Copyright (c) 2014-2017, Christopher Jeffrey (MIT License).
- Copyright (c) 2018, mxbit developers.

See LICENSE for more info.

[bcoin]: https://bcoin.io
[purse]: https://purse.io
[freenode]: https://freenode.net/
[irc]: irc://irc.freenode.net/bcoin
[guide]: ./docs/Beginner's-Guide.md
[changelog]: ./CHANGELOG.md


[coverage-status-img]: https://codecov.io/gh/bcoin-org/mxbit/badge.svg?branch=master
[coverage-status-url]: https://codecov.io/gh/bcoin-org/mxbit?branch=master
[circleci-status-img]: https://circleci.com/gh/bcoin-org/mxbit/tree/master.svg?style=shield
[circleci-status-url]: https://circleci.com/gh/bcoin-org/mxbit/tree/master