react-openpublish-assets
v1.3.2
Published
A React component for querying and rendering OpenPublish assets
Downloads
56
Readme
react-openpublish-assets
A React component for querying and rendering OpenPublish assets. OpenPublish is a publishing protocol for registering media as a digital asset on the Bitcoin blockchain. The OpenPublish protocol allows claiming ownership over a digital asset that can be used by other products to represent a limited and non-exclusive copyright of this document. Assets published through OpenPublish on coinvote and coinvote-testnet are available for view on react-openpublish-assets.
Install
Install react-openpublish-assets with the following command:
npm install react-openpublish-assets --save
Usage
To use react-openpublish-assets, require the module:
var Assets = require('react-openpublish-assets');
The module requires two parameters: address
and network
. The address
parameter is required. The network
parameter is optional. If no network
parameter is specified, 'testnet'
will be used by default. The following are sample JSX Instantiations:
// Mainnet: http://coinvote.herokuapp.com
<Assets address='1HUTmSsFp9Rg4FYRftp85GGyZFEndZSoeq' network='mainnet' />
// Testnet: http://coinvote-testnet.herokuapp.com
<Assets address='mjf6CRReqGSyvbgryjE3fbGjptRRfAL7cg' network='testnet' />
Example
In ./example/example.js
, the address
and network
can be changed to any valid coinvote or coinvote-testnet account.
To see the provided example, run the following command to install the dependencies:
npm install
Then, run:
npm start
and go to localhost:5000
in your browser.
For a live, working demo on the web, click here.
Development
Feel free to develop on react-openpublish-assets. To test modifications during development, run the following command:
npm start