From 0de25084faafb45d2ce7ba45b87ffff1c2b73af6 Mon Sep 17 00:00:00 2001 From: Benedikt Franke Date: Thu, 15 Feb 2024 09:19:48 +0100 Subject: [PATCH] Improve docs --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9fb17ff..2f767d3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Laravel GraphiQL -Easily integrate [GraphiQL](https://github.com/graphql/graphiql/tree/main/packages/graphiql) into your Laravel projects. +A thin wrapper for serving [the GraphiQL UI](https://github.com/graphql/graphiql/tree/main/packages/graphiql) from Laravel [![GitHub license](https://img.shields.io/github/license/mll-lab/laravel-graphiql.svg)](https://github.com/mll-lab/laravel-graphqil/blob/master/LICENSE) [![Packagist](https://img.shields.io/packagist/v/mll-lab/laravel-graphiql.svg)](https://packagist.org/packages/mll-lab/laravel-graphqil) @@ -9,12 +9,17 @@ Easily integrate [GraphiQL](https://github.com/graphql/graphiql/tree/main/packag ![Screenshot of GraphiQL with Doc Explorer Open](https://raw.githubusercontent.com/graphql/graphiql/main/packages/graphiql/resources/graphiql.png) > **Please note**: This a UI for testing and exploring your schema and does not include a GraphQL server implementation. -> To host GraphQL from Laravel, we recommend [nuwave/lighthouse](https://github.com/nuwave/lighthouse). +> To serve a GraphQL API from Laravel, we recommend [nuwave/lighthouse](https://github.com/nuwave/lighthouse). ## Installation +Install the package via [composer](https://getcomposer.org): + composer require mll-lab/laravel-graphiql +Due to [Laravel package discovery](https://laravel.com/docs/packages#package-discovery), +this package will automatically register and is ready to use without configuration. + If you are using Lumen, register the service provider in `bootstrap/app.php` ```php