Skip to content

Commit d152d5b

Browse files
committed
Updated README
1 parent 69b3433 commit d152d5b

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.markdown

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
# Grind Example API
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>
2+
3+
<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>
8+
</p>
9+
10+
# Grind API Template
11+
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.
213

314
## Installation
415

@@ -25,11 +36,19 @@ bin/cli serve --cluster
2536
bin/cli serve
2637
```
2738

28-
You should now be able to go to [localhost:3000/states](http://localhost:3000/states).
39+
You should now be able to visit [localhost:3000/states](http://localhost:3000/states).
2940

3041
Other URLs:
3142

3243
* Paged: [localhost:3000/states?limit=10](http://localhost:3000/states?limit=10)
3344
* Individual: [localhost:3000/states/ny](http://localhost:3000/states/ny)
3445
* Search: [localhost:3000/states/search?term=new](http://localhost:3000/states/search?term=new)
3546
* Swagger: [petstore.swagger.io/?url=http://localhost:3000/swagger.json](http://petstore.swagger.io/?url=http://localhost:3000/swagger.json)
47+
48+
## Documentation
49+
50+
Full documentation for Grind is available on the [Grind website](https://grind.rocks/).
51+
52+
## License
53+
54+
Grind was created by [Shaun Harrison](https://github.com/shnhrrsn) and is made available under the [MIT license](LICENSE).

0 commit comments

Comments
 (0)