Skip to content

Commit f5dbfe3

Browse files
author
Logan Gingerich
authored
Update README for SDK consistency (#15)
1 parent ab76f42 commit f5dbfe3

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
1-
# workos-php-laravel
1+
# WorkOS PHP Laravel Library
22

3-
Laravel SDK to conveniently access the [WorkOS API](https://workos.com).
3+
The WorkOS library for Laravel provides convenient access to the WorkOS API from applications written in Laravel.
44

5-
For more information on our API and WorkOS, check out our docs [here](https://docs.workos.com).
5+
## Documentation
6+
7+
See the [API Reference](https://workos.com/docs/reference/client-libraries) for Laravel usage examples.
68

79
## Installation
810

911
To install via composer, run the following:
12+
1013
```bash
1114
composer require workos/workos-php-laravel
1215
```
1316

1417
For Laravel 5.0-5.4, add the WorkOS ServiceProvider in your `config/app.php`:
18+
1519
```php
1620
"providers" => array(
1721
// ...
@@ -21,16 +25,20 @@ For Laravel 5.0-5.4, add the WorkOS ServiceProvider in your `config/app.php`:
2125

2226
For Laravel 5.5 and up, 6.x and 7.x... you're all set!
2327

24-
## Getting Started
28+
## Configuration
2529

2630
Create a WorkOS configuration file by running the following:
31+
2732
```bash
2833
php artisan vendor:publish --provider="WorkOS\Laravel\WorkOSServiceProvider"
2934
```
3035

3136
The package will need to be configured with your [api key](https://dashboard.workos.com/api-keys) and [project id](https://dashboard.workos.com/sso/configuration).
3237
By default, the package will look for a `WORKOS_API_KEY` and `WORKOS_PROJECT_ID` environment variable.
3338

34-
## Usage
39+
## More Information
3540

36-
Underneath it all, the Laravel SDK utilizes the WorkOS PHP SDK. For more information on usage, check out the docs [here](https://docs.workos.com/sdk/laravel) and the PHP SDK [here](https://github.com/workos-inc/workos-php).
41+
* [Single Sign-On Guide](https://workos.com/docs/sso/guide)
42+
* [Directory Sync Guide](https://workos.com/docs/directory-sync/guide)
43+
* [Admin Portal Guide](https://workos.com/docs/admin-portal/guide)
44+
* [Magic Link Guide](https://workos.com/docs/magic-link/guide)

0 commit comments

Comments
 (0)