Skip to content

Commit

Permalink
Add docs for plasma-js
Browse files Browse the repository at this point in the history
  • Loading branch information
smartcontracts committed Mar 18, 2019
1 parent 3337038 commit bd921b1
Show file tree
Hide file tree
Showing 5 changed files with 954 additions and 1 deletion.
2 changes: 1 addition & 1 deletion packages/contracts/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# plasma-contracts
[![Build Status](https://travis-ci.org/plasma-group/plasma-contracts.svg?branch=master)](https://travis-ci.org/plasma-group/plasma-contracts)

`plasma-contracts` is the set of smart contracts written in Vyper for the Plasma Group series of projects. It includes an implementation of a Plasma Cash variant, and a registry contract for discovering Plasma chains. This repo is used for compiling those contracts--If you don't need any modifications, you can spin up your own with [`plasma-chain-operator`](https://github.com/plasma-group/plasma-chain-operator) or try out other chains with [`plasma-js-lib`](https://github.com/plasma-group/plasma-js-lib).
`plasma-contracts` is the set of smart contracts written in Vyper for the Plasma Group series of projects. It includes an implementation of a Plasma Cash variant, and a registry contract for discovering Plasma chains. This repo is used for compiling those contracts--If you don't need any modifications, you can spin up your own with [`plasma-chain-operator`](https://github.com/plasma-group/plasma-chain-operator) or try out other chains with [`@pigi/plasma-js`](https://github.com/plasma-group/@pigi/plasma-js).

## Contributing
If you're looking to contribute to `plasma-contracts`, you're in the right place. Welcome!
Expand Down
18 changes: 18 additions & 0 deletions packages/docs/src/plasma-js/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
===========================================
``@pigi/plasma-js`` - Plasma JavaScript API
===========================================
Hello and welcome to the documentation of Plasma Group's ``@pigi/plasma-js``!
``@pigi/plasma-js`` is a simple JavaScript library that makes it easy for you to interact with a plasma chain.

.. toctree::
:maxdepth: 2
:caption: User Documentation

getting-started

.. toctree::
:maxdepth: 2
:caption: API Reference

api/plasma-client
api/plasma-operator

0 comments on commit bd921b1

Please sign in to comment.