https://github.com/bigchaindb/ilp-plugin-bigchaindb

ILP ledger plugin for BigchainDB
https://github.com/bigchaindb/ilp-plugin-bigchaindb

ilp ilp-ledger-plugin interledger-protocol

Last synced: 2 months ago
JSON representation

ILP ledger plugin for BigchainDB

• Host: GitHub
• URL: https://github.com/bigchaindb/ilp-plugin-bigchaindb
• Owner: bigchaindb
• License: apache-2.0
• Created: 2016-06-16T12:04:18.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-09-01T20:50:24.000Z (over 4 years ago)
• Last Synced: 2024-10-12T23:35:58.066Z (3 months ago)
• Topics: ilp, ilp-ledger-plugin, interledger-protocol
• Language: JavaScript
• Homepage:
• Size: 261 KB
• Stars: 9
• Watchers: 4
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [![ilp-plugin-bigchaindb](media/[email protected])](https://www.bigchaindb.com)

> ILP ledger plugin for [BigchainDB](https://github.com/bigchaindb/bigchaindb)

[![npm](https://img.shields.io/npm/v/ilp-plugin-bigchaindb.svg)](https://www.npmjs.com/package/ilp-plugin-bigchaindb)

[![js ascribe](https://img.shields.io/badge/js-ascribe-39BA91.svg)](https://github.com/ascribe/javascript)

[![Build Status](https://travis-ci.org/bigchaindb/ilp-plugin-bigchaindb.svg?branch=master)](https://travis-ci.org/bigchaindb/ilp-plugin-bigchaindb)

[![Greenkeeper badge](https://badges.greenkeeper.io/bigchaindb/ilp-plugin-bigchaindb.svg)](https://greenkeeper.io/)

## Installation

```bash

npm install ilp-plugin-bigchaindb

```

## Usage

Depending on your build system and preferences, you can use any of the following exports:

### CommonJS (default package export)

```js

const BigchainDBLedgerPlugin = require('ilp-plugin-bigchaindb')

```

### ES6 modules

```js

import BigchainDBLedgerPlugin from 'ilp-plugin-bigchaindb/es6'

```

### Bundled version (UMD export)

Add `/bundle/bundle.min.js` to your HTML and use `window.BigchainDBLedgerPlugin`:

```html

    window.BigchainDBLedgerPlugin;

```

## npm releases

For a new **patch release**, execute on the machine where you're logged into your npm account:

```bash

npm run release

```

Command is powered by [`release-it`](https://github.com/webpro/release-it) package, defined in the `package.json`.

That's what the command does without any user interaction:

- create release commit by updating version in `package.json`

- create tag for that release commit

- push commit & tag

- create a new release on GitHub, with change log auto-generated from commit messages

- publish to npm as a new release

If you want to create a **minor** or **major release**, use these commands:

```bash

npm run release-minor

```

```bash

npm run release-major

```

## License

```

Copyright 2017 BigchainDB GmbH

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

```