Skip to content

Commit ee3f9ca

Browse files
authored
Update README.md
1 parent 02b5af7 commit ee3f9ca

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

README.md

+23-16
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,29 @@
11
<h1 align="center"> Notion for Laravel</h1>
22

3-
<img src="open-graph.png">
3+
<div align="center">
4+
<img src="https://notionforlaravel.com/images/open-graph.png" alt="Notion For Laravel" width="500">
5+
46

57
[![Latest Version on Packagist](https://img.shields.io/packagist/v/fiveam-code/laravel-notion-api.svg?style=flat-square)](https://packagist.org/packages/fiveam-code/laravel-notion-api)
68
[![Total Downloads](https://img.shields.io/packagist/dt/fiveam-code/laravel-notion-api.svg?style=flat-square)](https://packagist.org/packages/fiveam-code/laravel-notion-api)
79

810
[comment]: <> (![GitHub Actions]&#40;https://github.com/fiveam-code/laravel-notion-api/actions/workflows/main.yml/badge.svg&#41;)
9-
11+
</div>
1012
This package provides a simple and crisp way to access the Notion API endpoints, query data and update existing entries.
1113

14+
# Documentation
15+
16+
For a extensive documentation, more context and usage examples, head over to the official documentation at [notionforlaravel.com](https://notionforlaravel.com).
17+
18+
19+
# Quick Start Guide
20+
21+
All examples refer to our test database, which you can
22+
find [here](https://dianawebdev.notion.site/8284f3ff77e24d4a939d19459e4d6bdc?v=bc3a9ce8cdb84d3faefc9ae490136ac2).
23+
1224
## Installation
1325

14-
The package is compatible with Laravel 8, 9 and 10 with their respective PHP versions.
26+
The package is compatible with Laravel 8, 9 and 10. The minimum PHP requirement is 8.0.
1527

1628
1. Install the package via composer:
1729

@@ -43,8 +55,6 @@ For detailed usage information and a list of available endpoints see (the docs).
4355

4456
## Examples
4557

46-
All examples refer to our test database, which you can
47-
find [here](https://dianawebdev.notion.site/8284f3ff77e24d4a939d19459e4d6bdc?v=bc3a9ce8cdb84d3faefc9ae490136ac2).
4858

4959
### Fetch a Notion Database
5060

@@ -137,23 +147,20 @@ $filterBag->addFilter(
137147
->asCollection();
138148
```
139149

140-
### Testing (pestphp)
150+
### Tests
141151

142152
You can find even more usage examples by checking out the package tests in the `/tests` directory.
143-
The tests are making use of Pest PHP and we are working on switching from PHPUNIT to it (todo sentence).
153+
We are using [Pest](https://pestphp.com/) for out tests and are currently in the process of switching all existing PHPUnit tests to Pest.
144154

145155
If you want to run the tests in your CLI:
146156

147157
```bash
148158
vendor/bin/pest tests
149159
```
150160

151-
## Support
152-
153-
If you use this package in one of your projects or want to support our development, consider becoming
154-
a [Patreon Supporter](https://www.patreon.com/bePatron?u=56662485)!
161+
# Support
155162

156-
### Supported by Tinkerwell
163+
## Supported by Tinkerwell
157164

158165
<a href="https://tinkerwell.app/">
159166
<img src="https://tinkerwell.app/images/tinkerwell_logo.png" width="64" height="64" alt="Tinkerwell"> <br/>
@@ -162,15 +169,15 @@ a [Patreon Supporter](https://www.patreon.com/bePatron?u=56662485)!
162169
The development of this package is supported by [Tinkerwell](https://tinkerwell.app/).
163170

164171

165-
## Contributing
172+
# Contributing
166173

167174
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
168175

169-
## Security
176+
# Security
170177

171178
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
172179

173-
## Credits
180+
# Credits
174181

175182
- [Diana Scharf](https://github.com/mechelon)
176183
- [Johannes Güntner](https://github.com/johguentner)
@@ -179,6 +186,6 @@ If you discover any security related issues, please email [email protected] ins
179186
<img src="https://5amco.de/images/5am.png" width="200" height="200">
180187
</p>
181188

182-
## License
189+
# License
183190

184191
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

0 commit comments

Comments
 (0)