Skip to content

Commit 001633f

Browse files
committed
Updated keywords and readme
1 parent 058a880 commit 001633f

File tree

3 files changed

+43
-0
lines changed

3 files changed

+43
-0
lines changed

Readme.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,38 @@
22

33
Create ReScript apps with no build configuration.
44

5+
## Quick Start
6+
7+
```sh
8+
npx create-rescript-app my-app
9+
cd my-app
10+
npm start
11+
```
12+
13+
## Install options
14+
15+
| Template | short cmd | long cmd |
16+
| :------------------------------- | :-------: | ----------: |
17+
| Basic | -b | --basic |
18+
| Default / CRA equivalent (React) | -d | --default |
19+
| NextJS | -nx | --nextjs |
20+
| GraphQL | -gql | --graphql |
21+
| Storybook | -sb | --storybook |
22+
23+
### Bootstrap a ReScript app with Graphql
24+
25+
```sh
26+
npx create-rescript-app my-app -gql
27+
```
28+
29+
### Bootstrap a ReScript app with Storybook
30+
31+
```sh
32+
npx create-rescript-app my-app -sb
33+
```
34+
35+
### Bootstrap a NextJS app with ReScript
36+
37+
```sh
38+
npx create-rescript-app my-app -nx
39+
```

package-lock.json

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@
2525
"url": "https://github.com/mahezsh/create-rescript-app/issues"
2626
},
2727
"homepage": "https://github.com/mahezsh/create-rescript-app#readme",
28+
"keywords": [
29+
"rescript",
30+
"bootstrap rescript",
31+
"rescript app",
32+
"rescript start"
33+
],
2834
"bin": {
2935
"create-rescript-app": "index.js"
3036
}

0 commit comments

Comments
 (0)