Skip to content

Commit 33c2b36

Browse files
committed
[Docs] Update changelog for initial alpha release
1 parent c4f5a3c commit 33c2b36

File tree

3 files changed

+34
-13
lines changed

3 files changed

+34
-13
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file. This project adheres to
4+
[Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
5+
6+
## [1.0.0-alpha.1] - 2021-01-25
7+
8+
Initial release.

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,22 @@
1-
# laravel-json-api/laravel
1+
# JSON:API for Web Artisans
22

3-
## Status
3+
Implement feature-rich [JSON:API](https://jsonapi.org) compliant APIs in your
4+
[Laravel](https://laravel.com) applications. Build your next standards-compliant API today.
45

5-
This package is in development.
6+
## Documentation
7+
8+
See our website, [laraveljsonapi.io](https://laraveljsonapi.io)
9+
10+
## Installation
11+
12+
Install using [Composer](https://getcomposer.org)
13+
14+
```bash
15+
composer require laravel-json-api/laravel
16+
```
17+
18+
See our documentation for further installation instructions.
619

720
## License
821

9-
Laravel JSON API is open-sourced software licensed under the [Apache 2.0 License](./LICENSE).
22+
Laravel JSON:API is open-sourced software licensed under the [Apache 2.0 License](./LICENSE).

composer.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "laravel-json-api/laravel",
3-
"description": "JSON API for Laravel applications.",
3+
"description": "JSON:API for Laravel applications.",
44
"keywords": [
55
"jsonapi.org",
66
"json-api",
@@ -25,16 +25,16 @@
2525
"require": {
2626
"php": "^7.4|^8.0",
2727
"ext-json": "*",
28-
"laravel-json-api/core": "^1.0",
29-
"laravel-json-api/eloquent": "^1.0",
30-
"laravel-json-api/encoder-neomerx": "^1.0",
31-
"laravel-json-api/exceptions": "^1.0",
32-
"laravel-json-api/spec": "^1.0",
33-
"laravel-json-api/validation": "^1.0",
28+
"laravel-json-api/core": "^1.0.0-alpha.1",
29+
"laravel-json-api/eloquent": "^1.0.0-alpha.1",
30+
"laravel-json-api/encoder-neomerx": "^1.0.0-alpha.1",
31+
"laravel-json-api/exceptions": "^1.0.0-alpha.1",
32+
"laravel-json-api/spec": "^1.0.0-alpha.1",
33+
"laravel-json-api/validation": "^1.0.0-alpha.1",
3434
"laravel/framework": "^8.0"
3535
},
3636
"require-dev": {
37-
"laravel-json-api/testing": "^1.0",
37+
"laravel-json-api/testing": "^1.0@alpha",
3838
"orchestra/testbench": "^6.9",
3939
"phpunit/phpunit": "^9.5"
4040
},
@@ -65,7 +65,7 @@
6565
}
6666
}
6767
},
68-
"minimum-stability": "dev",
68+
"minimum-stability": "stable",
6969
"prefer-stable": true,
7070
"config": {
7171
"sort-packages": true

0 commit comments

Comments
 (0)