Skip to content

Commit 303ddc3

Browse files
authored
docs: cleanup and minor marketing improvements (#6525)
* fix: ignore more files in the Laravel package archive * chore: various minor docs improvements
1 parent d81fc61 commit 303ddc3

File tree

8 files changed

+76
-27
lines changed

8 files changed

+76
-27
lines changed

composer.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@
1111
"JSONAPI",
1212
"OpenAPI",
1313
"HAL",
14-
"Swagger"
14+
"Swagger",
15+
"Symfony",
16+
"Laravel"
1517
],
1618
"homepage": "https://api-platform.com",
1719
"license": "MIT",

src/Laravel/.gitattributes

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
/.gitattributes export-ignore
22
/.gitignore export-ignore
3-
/workbench export-ignore
3+
/phpstan.neon.dist export-ignore
4+
/phpunit.xml.dist export-ignore
5+
/CONTRIBUTING.md
6+
/testbench.yaml
47
/Tests export-ignore
8+
/workbench export-ignore

src/Laravel/CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Contributing to the Laravel Integration of API Platform
2+
3+
## Tests
4+
5+
cd src/Laravel
6+
composer global require soyuka/pmu
7+
composer global link ../../
8+
vendor/bin/testbench workbench:build
9+
vendor/bin/testbench package:test
10+
# or
11+
vendor/bin/phpunit
12+
13+
A command is available to remove the database:
14+
15+
vendor/bin/testbench workbench:drop-sqlite-db
16+
17+
## Starting the Test App
18+
19+
The test server is also available through:
20+
21+
vendor/bin/testbench serve

src/Laravel/LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT license
2+
3+
Copyright (c) 2024-present Kévin Dunglas
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is furnished
10+
to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

src/Laravel/README.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,3 @@
1-
# API Platform - Laravel
2-
3-
## Tests
4-
5-
cd src/Laravel
6-
composer global require soyuka/pmu
7-
composer global link ../../
8-
vendor/bin/testbench workbench:build
9-
vendor/bin/testbench package:test
10-
# or
11-
vendor/bin/phpunit
12-
13-
The test server is also available through:
14-
15-
vendor/bin/testbench serve
16-
17-
A command is available to remove the database:
18-
19-
vendor/bin/testbench workbench:drop-sqlite-db
1+
# Laravel Integration of API Platform
202

3+
Integrates [API Platform](https://api-platform.com) into the [Laravel](https://laravel.com) framework and the Illuminate components.

src/Laravel/composer.json

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,16 @@
22
"name": "api-platform/laravel",
33
"description": "API Platform support for Laravel",
44
"keywords": [
5-
"todo"
5+
"Laravel",
6+
"REST",
7+
"GraphQL",
8+
"API",
9+
"JSON-LD",
10+
"Hydra",
11+
"JSONAPI",
12+
"OpenAPI",
13+
"HAL",
14+
"Swagger"
615
],
716
"homepage": "https://api-platform.com",
817
"license": "MIT",
@@ -99,4 +108,4 @@
99108
"@php vendor/bin/phpstan analyse --verbose --ansi"
100109
]
101110
}
102-
}
111+
}

src/Symfony/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# API Platform - Symfony
2-
1+
# Symfony Integration of API Platform
32

3+
Integrates [API Platform](https://api-platform.com) into the [Symfony](https://symfony.com) framework and components.

src/Symfony/composer.json

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
{
22
"name": "api-platform/symfony",
3-
"description": "Symfony API Platform integration",
3+
"description": "API Platform support for Symfony",
44
"type": "library",
55
"keywords": [
6-
"API"
6+
"Symfony",
7+
"REST",
8+
"GraphQL",
9+
"API",
10+
"JSON-LD",
11+
"Hydra",
12+
"JSONAPI",
13+
"OpenAPI",
14+
"HAL",
15+
"Swagger"
716
],
817
"homepage": "https://api-platform.com",
918
"license": "MIT",

0 commit comments

Comments
 (0)