Skip to content

Commit

Permalink
fix(README): add example installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
shanejonas committed Jul 9, 2019
1 parent f9b810e commit a83d5ec
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,19 @@ Pristine Typescript OpenRPC Server a fork of [Pristine](https://github.com/etcla

There are a lack of repositories to start from to build community driven open source projects. Pristine Typescript is a complete starting point, it follows a Documentation Driven Development approach, and can be used as a resource to augment existing documentation.


## Generated Clients
This pristine OpenRPC starting point auto generates clients to interact with this server when released via `semantic-release`. You can test out the generated ones from this repo:

### Typescript/Javascript

`npm install @etclabscore/pristine-typescript-openrpc-server-client`

or add this to your `Cargo.toml`

### Rust
`pristine-typescript-openrpc-server-client = "1.1.2"`

## How to use Pristine in your project

There are 2 options for using pristine with your project.
Expand Down

0 comments on commit a83d5ec

Please sign in to comment.