Skip to content

Commit 04fd22f

Browse files
committed
docs(grind-example-api): update readme
1 parent 07f0f97 commit 04fd22f

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

README.markdown

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,38 @@
1-
<p align="center"><a href="https://grind.rocks"><img src="https://s3.amazonaws.com/assets.grind.rocks/docs/img/grind-template-api.svg" alt="Grind Template API" /></a></p>
1+
<p align="center"><a href="https://grind.rocks"><img src="https://assets.grind.rocks/docs/img/grind-template-api.svg" alt="Grind Template API" /></a></p>
22

33
<p align="center">
4-
<a href="https://travis-ci.org/grindjs/example-api"><img src="https://img.shields.io/travis/grindjs/example-api.svg" alt="Build Status"></a>
5-
<a href="https://github.com/grindjs/example-api"><img src="https://img.shields.io/github/tag/grindjs/example-api.svg" alt="Latest Version"></a>
6-
<a href="https:/grind.chat"><img src="https://grind.chat/badge.svg" alt="Slack"></a>
7-
<a href="https://github.com/grindjs/example-api"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License"></a>
4+
<a href=".https://github.com/grindjs/grindjs/tree/master/starters/api"><img src="https://img.shields.io/github/tag/grindjs/example-api.svg" alt="Latest Version"></a>
5+
<a href="https://chat.grind.rocks"><img src="https://chat.grind.rocks/badge.svg" alt="Slack"></a>
6+
<a href="https://github.com/grindjs/grindjs/tree/master/starters/api"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License"></a>
87
</p>
98

109
# Grind API Template
1110

12-
The Grind API Template is an example project for building API’s on [Grind](https://github.com/grindjs/framework). It’s also used as a template in [Grind Installer](https://github.com/grindjs/installer) so you can quickly setup a new API project.
11+
The Grind API Template is an example project for building API’s on [Grind](https://github.com/grindjs/grindjs). It’s also used as a template in [Grind Toolkit](https://github.com/grindjs/grindjs/tree/master/packages/toolkit) so you can quickly setup a new API project.
1312

1413
## Installation
1514

1615
```bash
1716
git clone https://github.com/grindjs/example-api.git grind-example-api
1817
cd grind-example-api
19-
npm install
20-
bin/cli migrate:latest
21-
bin/cli db:seed
18+
yarn install
19+
yarn cli migrate:latest
20+
yarn cli db:seed
2221
```
2322

2423
## Running
2524

2625
```bash
2726
# Use `watch` to automatically restart the server on file changes
2827
# Watch is recommended for development
29-
bin/cli watch
28+
yarn cli watch
3029

3130
# Use `serve --cluster` to launch a cluster of workers
3231
# Cluster is recommended for production
33-
bin/cli serve --cluster
32+
yarn cli serve --cluster
3433

3534
# Use `serve` to launch a single worker
36-
bin/cli serve
35+
yarn cli serve
3736
```
3837

3938
You should now be able to visit [localhost:3000/states](http://localhost:3000/states).

0 commit comments

Comments
 (0)