Skip to content

Commit 2b9522e

Browse files
authored
Update README.md
updated readme with more info from docs
1 parent 88ecdef commit 2b9522e

1 file changed

Lines changed: 27 additions & 2 deletions

File tree

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,35 @@
55
Strongly Typed GraphQL from the team at [GraphQL Editor](https://graphqleditor.com/?utm_source=graphql_zeus_github)
66

77
# Install
8-
`npm install graphql-zeus`
8+
9+
```
10+
$ npm i -g graphql-zeus
11+
# OR
12+
# yarn global add graphql-zeus
13+
```
14+
You can also install it locally to a project and then use it as an npm or yarn script command using `npx` or `yarn` directly like this:
15+
16+
```
17+
$ npx zeus schema.graphql ./
18+
# OR
19+
# yarn zeus schema.graphql ./
20+
```
21+
22+
## TypeScript
23+
24+
Zeus is TypeScript native, you can refer to imported types directly from the generated output of the CLI
25+
26+
```
27+
$ zeus schema.graphql ./
28+
```
929

1030
# Generate
11-
`zeus <file-or-backend-schema-url>`
31+
To generate clients simply run this command:
32+
33+
| For NodeJS | For React Native |
34+
|-------------------------------------|----------------------------------|
35+
| `$ zeus schema.graphql ./ --node` | `$ zeus schema.graphql ./` |
36+
1237

1338
## How it works
1439

0 commit comments

Comments
 (0)