solana/web3.js/README.md

35 lines
1.3 KiB
Markdown
Raw Normal View History

[![Build status](https://api.travis-ci.org/solana-labs/solana-web3.js.svg?branch=master)](https://travis-ci.org/solana-labs/solana-web3.js)
[![Coverage Status](https://coveralls.io/repos/github/solana-labs/solana-web3.js/badge.svg?branch=master)](https://coveralls.io/github/solana-labs/solana-web3.js?branch=master)
2018-08-22 16:04:16 -07:00
[![npm](https://img.shields.io/npm/v/@solana/web3.js.svg?style=flat)](https://www.npmjs.com/package/@solana/web3.js)
# Solana JavaScript API
This is the Solana Javascript API built on the Solana JSON RPC API (**TODO: add
link**).
2018-08-22 13:53:13 -07:00
[Latest API Documentation](https://solana-labs.github.io/solana-web3.js/)
2018-08-22 20:06:29 -07:00
## Getting started
```
$ npm install --save @solana/web3.js
```
## Examples
See the [examples/](https://github.com/solana-labs/solana-web3.js/tree/master/examples)
for simple examples of using the API from node.
Browser-based examples are also available:
* Account creation - https://jsfiddle.net/mvines/sz4pco6y/
## Releases
2018-08-22 20:06:29 -07:00
Releases are available on [Github](https://github.com/solana-labs/solana-web3.js/releases)
and [npmjs.com](https://www.npmjs.com/package/@solana/web3.js).
2018-08-22 20:06:29 -07:00
Each Github release features a tarball containing the API documentation release
and a minified version of the module suitable for direct use in a browser
environment (<script> tag)