Skip to content

Commit bf33b33

Browse files
chore: update README.md, add logo
Co-authored-by: Julian Schramm <[email protected]>
1 parent cf7c97f commit bf33b33

File tree

3 files changed

+25
-6
lines changed

3 files changed

+25
-6
lines changed

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
1-
# Laravel Stateful Resources
1+
<div align="center">
2+
<h1> Laravel Stateful Resources </h1>
23

34
[![Latest Version on Packagist](https://img.shields.io/packagist/v/farbcode/laravel-stateful-resources.svg?style=flat-square)](https://packagist.org/packages/farbcode/laravel-stateful-resources)
45
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/farbcodegmbh/laravel-stateful-resources/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/farbcodegmbh/laravel-stateful-resources/actions?query=workflow%3Arun-tests+branch%3Amain)
56
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/farbcodegmbh/laravel-stateful-resources/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/farbcodegmbh/laravel-stateful-resources/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
67
[![Total Downloads](https://img.shields.io/packagist/dt/farbcode/laravel-stateful-resources.svg?style=flat-square)](https://packagist.org/packages/farbcode/laravel-stateful-resources)
78

8-
A Laravel package for managing state in API resources.
9+
<p>A Laravel package for managing state in API resources.</p>
10+
</div>
911

10-
**Features:**
12+
## Features
1113

1214
- 🧘🏻‍♂️ **Unified Resources:** Provide multiple resource representations through a single resource class.
1315
- 🏗️ **Built-in States:** Comes with default states for common use cases.
@@ -16,16 +18,33 @@ A Laravel package for managing state in API resources.
1618

1719
## Documentation
1820

19-
Check out the [official documentation website](https://stateful-resources.farbcode.net).
21+
All information on how to use this package can be found on our official documentation website.
22+
23+
[→ Read the Docs](https://stateful-resources.farbcode.net)
2024

2125
## Changelog
2226

23-
See [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
27+
Notable changes to this package are documented in our changelog for every new release.
28+
29+
[→ See what's changed](CHANGELOG.md)
2430

2531
## Contributing
2632

27-
See [CONTRIBUTING](CONTRIBUTING.md) for details.
33+
We welcome contributions to this package.
34+
35+
[→ Read our Contribution Guidelines](CONTRIBUTING.md)
36+
37+
[→ Open an Issue](https://github.com/farbcodegmbh/laravel-stateful-resources/issues)
38+
39+
[→ Submit a Pull Request](https://github.com/farbcodegmbh/laravel-stateful-resources/pulls)
2840

2941
## License
3042

3143
The MIT License (MIT). See [License File](LICENSE.md) for more information.
44+
45+
---
46+
47+
[![farbcode Logo Light](/art/farbcode-logo-light.png#gh-light-mode-only)](https://farbcode.net)
48+
[![farbcode Logo Dark](/art/farbcode-logo-dark.png#gh-dark-mode-only)](https://farbcode.net)
49+
50+
> Made with ❤️ by [//farbcode](https://farbcode.net).

art/farbcode-logo-dark.png

55.5 KB
Loading

art/farbcode-logo-light.png

57.2 KB
Loading

0 commit comments

Comments
 (0)