Skip to content

Commit 0183ad8

Browse files
committed
update readme
1 parent 0d19644 commit 0183ad8

File tree

2 files changed

+33
-1
lines changed

2 files changed

+33
-1
lines changed

Diff for: README.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Laravel WorkOS Utilities
2+
3+
<p align="center">
4+
<a href="https://github.com/laravel/workos/actions"><img src="https://github.com/laravel/workos/workflows/tests/badge.svg" alt="Build Status"></a>
5+
<a href="https://packagist.org/packages/laravel/workos"><img src="https://img.shields.io/packagist/dt/laravel/workos" alt="Total Downloads"></a>
6+
<a href="https://packagist.org/packages/laravel/workos"><img src="https://img.shields.io/packagist/v/laravel/workos" alt="Latest Stable Version"></a>
7+
<a href="https://packagist.org/packages/laravel/workos"><img src="https://img.shields.io/packagist/l/laravel/workos" alt="License"></a>
8+
</p>
9+
10+
## Introduction
11+
12+
These Laravel WorkOS utilities are used by the [Laravel starter kits](https://laravel.com/docs/starter-kits) to integrate with WorkOS AuthKit.
13+
14+
## Official Documentation
15+
16+
Documentation for our starter kits can be found on the [Laravel website](https://laravel.com/docs/starter-kits).
17+
18+
## Contributing
19+
20+
Thank you for considering contributing to our WorkOS utilities! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
21+
22+
## Code of Conduct
23+
24+
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
25+
26+
## Security Vulnerabilities
27+
28+
Please review [our security policy](https://github.com/laravel/workos/security/policy) on how to report security vulnerabilities.
29+
30+
## License
31+
32+
This library is open-sourced software licensed under the [MIT license](LICENSE.md).

Diff for: composer.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "laravel/workos",
3-
"description": "Utilities for integrating Laravel starter kits and WorkOS.",
3+
"description": "Utilities for integrating the Laravel starter kits with WorkOS.",
44
"keywords": ["laravel", "workos"],
55
"homepage": "https://github.com/laravel/workos",
66
"license": "MIT",

0 commit comments

Comments
 (0)