Skip to content
This repository has been archived by the owner on Jun 7, 2019. It is now read-only.

Commit

Permalink
Merge branch '1.0.0' into 1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
willclarktech committed Jul 23, 2018
2 parents 165c265 + 3a0788a commit 185acf6
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,8 @@ jspm_packages
tmp

# Distribution folders
dist/
dist-node/
dist-browser/
**/browsertest/browsertest.js
**/browsertest/browsertest.min.js
dist-node/

# Unsupported lock files
yarn.lock
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Lisk Elements is a JavaScript library for [Lisk][Lisk Core GitHub], the blockcha

## Installation

## Installation via npm
### Installation via npm

Add Lisk Elements as a dependency of your project:

Expand Down Expand Up @@ -37,6 +37,13 @@ import { APIClient, transactions } from 'lisk-elements';
const { APIClient, transactions } = require('lisk-elements');
```

**Note:** If you are installing Lisk Elements as an npm dependency via a GitHub reference, you will need to manually build the distribution files by running the following commands from the root directory of your project:

```
cd node_modules/lisk-elements
npm run build
```

### Installation via CDN

Include the following script using the following HTML. The `lisk` variable will be exposed.
Expand All @@ -51,6 +58,17 @@ Or minified:
<script src="https://js.lisk.io/lisk-elements-1.0.0.min.js"></script>
```

### Installation from source

Our source code is hosted on GitHub. You can build the distribution yourself by cloning the repository, installing the relevant dependencies and running our build script as follows:

```
git clone https://github.com/LiskHQ/lisk-elements.git
cd lisk-elements
npm install
npm run build
```

## Usage

Access functionality via the relevant namespace. For example, the following will create and (locally) sign a transfer (type 0) transaction, and then broadcast it to the Lisk Testnet.
Expand Down

0 comments on commit 185acf6

Please sign in to comment.