Skip to content

Commit

Permalink
docs: cleanup and minor marketing improvements (#6525)
Browse files Browse the repository at this point in the history
* fix: ignore more files in the Laravel package archive

* chore: various minor docs improvements
  • Loading branch information
dunglas authored Aug 21, 2024
1 parent 6547f8f commit bc380d5
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 22 deletions.
6 changes: 5 additions & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
/.gitattributes export-ignore
/.gitignore export-ignore
/workbench export-ignore
/phpstan.neon.dist export-ignore
/phpunit.xml.dist export-ignore
/CONTRIBUTING.md
/testbench.yaml
/Tests export-ignore
/workbench export-ignore
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Contributing to the Laravel Integration of API Platform

## Tests

cd src/Laravel
composer global require soyuka/pmu
composer global link ../../
vendor/bin/testbench workbench:build
vendor/bin/testbench package:test
# or
vendor/bin/phpunit

A command is available to remove the database:

vendor/bin/testbench workbench:drop-sqlite-db

## Starting the Test App

The test server is also available through:

vendor/bin/testbench serve
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT license

Copyright (c) 2024-present Kévin Dunglas

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
21 changes: 2 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,3 @@
# API Platform - Laravel

## Tests

cd src/Laravel
composer global require soyuka/pmu
composer global link ../../
vendor/bin/testbench workbench:build
vendor/bin/testbench package:test
# or
vendor/bin/phpunit

The test server is also available through:

vendor/bin/testbench serve

A command is available to remove the database:

vendor/bin/testbench workbench:drop-sqlite-db
# Laravel Integration of API Platform

Integrates [API Platform](https://api-platform.com) into the [Laravel](https://laravel.com) framework and the Illuminate components.
13 changes: 11 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,16 @@
"name": "api-platform/laravel",
"description": "API Platform support for Laravel",
"keywords": [
"todo"
"Laravel",
"REST",
"GraphQL",
"API",
"JSON-LD",
"Hydra",
"JSONAPI",
"OpenAPI",
"HAL",
"Swagger"
],
"homepage": "https://api-platform.com",
"license": "MIT",
Expand Down Expand Up @@ -99,4 +108,4 @@
"@php vendor/bin/phpstan analyse --verbose --ansi"
]
}
}
}

0 comments on commit bc380d5

Please sign in to comment.