Skip to content

Commit

Permalink
fix: OpenRPC Document naming
Browse files Browse the repository at this point in the history
  • Loading branch information
stevanlohja committed Mar 30, 2019
1 parent 19b9e78 commit aab7846
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=open-rpc/generator-client)](https://dependabot.com) [![Dependabot Status](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/Tf55C7d)

Multi-language client generator tool for [open-rpc](https://github.com/open-rpc/spec) APIs. Developers generate a client by passing a raw open-rpc schema document to _this_ tool which generates a client based on the supported language templates.
Multi-language client generator tool for [open-rpc](https://github.com/open-rpc/spec) APIs. Developers generate a client by passing an OpenRPC Document to _this_ tool which generates a client based on the supported language templates.

![overview diagram](https://github.com/open-rpc/design/blob/master/diagrams/generator-client/open-rpc-diagrams.png?raw=true)

Expand Down Expand Up @@ -34,7 +34,7 @@ open-rpc-generator-client \
PetStore
```

Using the `open-rpc-generator-client` command, then passing an example schema document `petstore-openrpc.json` in the directory of `Petstore`.
Using the `open-rpc-generator-client` command, then passing an example OpenRPC document `petstore-openrpc.json` in the directory of `Petstore`.

### Using Docker ![docker-icon](https://github.com/open-rpc/design/blob/master/png/docker-icon-16x.png?raw=true)

Expand All @@ -43,7 +43,7 @@ In action (for a js client):
```shell
docker run \
-v $(pwd)/petstore/:/petstore \
openrpc/generator-client-js \
openrpc/generator-client \
-s https://raw.githubusercontent.com/open-rpc/examples/master/service-descriptions/petstore.json
petstore
```
Expand Down

0 comments on commit aab7846

Please sign in to comment.