8000 [Docs] Link to How to JSON:API tutorial in docs · BrianLangevin/laravel-json-api@f92d4ed · GitHub
[go: up one dir, main page]

Skip to content

Commit f92d4ed

Browse files
committed
[Docs] Link to How to JSON:API tutorial in docs
1 parent 7c2c1a8 commit f92d4ed

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,7 @@ The following additional features are also supported:
3333
- Support multiple media-types within your API.
3434
- Generators for all the classes you need to add a resource to your API.
3535

36-
Installation instructions and documentation are available on
37-
[Read the Docs](http://laravel-json-api.readthedocs.io/en/latest/).
38-
39-
> Credit where credit is due: this package is based on the framework agnostic package
40-
[neomerx/json-api](https://github.com/neomerx/json-api).
41-
42-
## What is JSON API?
36+
### What is JSON API?
4337

4438
From [jsonapi.org](http://jsonapi.org)
4539

@@ -52,6 +46,13 @@ efficiently caching responses, sometimes eliminating network requests entirely.
5246

5347
For full information on the spec, plus examples, see [http://jsonapi.org](http://jsonapi.org).
5448

49+
## Tutorial and Documentation
50+
51+
Want a tutorial to get started? Read the
52+
[Laravel tutorial on the *How to JSON:API* website.]((https://howtojsonapi.com/laravel.html))
53+
Full package documentation is available on
54+
[Read the Docs](http://laravel-json-api.readthedocs.io/en/latest/).
55+
5556
## Demo
5657

5758
A demo application is available at [here](https://github.com/cloudcreativity/demo-laravel-json-api).
@@ -75,10 +76,6 @@ Currently we have not integrated the package with Lumen. We do not have any acti
7576
so if you do and can help, please let us know on
7677
[this issue](https://github.com/cloudcreativity/laravel-json-api/issues/61).
7778

78-
## Documentation
79-
80-
Documentation is available on [Read the Docs](http://laravel-json-api.readthedocs.io/en/latest/).
81-
8279
## License
8380

8481
Apache License (Version 2.0). Please see [License File](LICENSE) for more information.

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ efficiently caching responses, sometimes eliminating network requests entirely.
1717

1818
For full information on the spec, plus examples, see [http://jsonapi.org](http://jsonapi.org).
1919

20+
## Tutorial
21+
22+
Want a tutorial to get started? Read the
23+
[Laravel tutorial on the *How to JSON:API* website.]((https://howtojsonapi.com/laravel.html))
24+
2025
## Demo
2126

2227
We've created a simple [demo application](https://github.com/cloudcreativity/demo-laravel-json-api) that is

0 commit comments

Comments
 (0)
0