Commit ee3f9ca

authored

Update README.md

1 parent 02b5af7 commit ee3f9caCopy full SHA for ee3f9ca

File tree

1 file changed

+23

-16

lines changed

README.md

1 file changed

+23

-16

lines changed

`‎README.md`

Lines changed: 23 additions & 16 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,17 +1,29 @@`
`1`	`1`	`<h1 align="center"> Notion for Laravel</h1>`
`2`	`2`
`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`	`+`
`4`	`6`
`5`	`7`	`[![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)`
`6`	`8`	`[![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)`
`7`	`9`
`8`	`10`	`[comment]: <> (![GitHub Actions](https://github.com/fiveam-code/laravel-notion-api/actions/workflows/main.yml/badge.svg))`
`9`		`-`
	`11`	`+</div>`
`10`	`12`	`This package provides a simple and crisp way to access the Notion API endpoints, query data and update existing entries.`
`11`	`13`
	`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`	`+`
`12`	`24`	`## Installation`
`13`	`25`
`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.`
`15`	`27`
`16`	`28`	`1. Install the package via composer:`
`17`	`29`
`@@ -43,8 +55,6 @@ For detailed usage information and a list of available endpoints see (the docs).`
`43`	`55`
`44`	`56`	`## Examples`
`45`	`57`
`46`		`-All examples refer to our test database, which you can`
`47`		`-find [here](https://dianawebdev.notion.site/8284f3ff77e24d4a939d19459e4d6bdc?v=bc3a9ce8cdb84d3faefc9ae490136ac2).`
`48`	`58`
`49`	`59`	`### Fetch a Notion Database`
`50`	`60`
`@@ -137,23 +147,20 @@ $filterBag->addFilter(`
`137`	`147`	`->asCollection();`
`138`	`148`	```
`139`	`149`
`140`		`-### Testing (pestphp)`
	`150`	`+### Tests`
`141`	`151`
`142`	`152`	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.`
`144`	`154`
`145`	`155`	`If you want to run the tests in your CLI:`
`146`	`156`
`147`	`157`	```bash
`148`	`158`	`vendor/bin/pest tests`
`149`	`159`	```
`150`	`160`
`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`
`155`	`162`
`156`		`-### Supported by Tinkerwell`
	`163`	`+## Supported by Tinkerwell`
`157`	`164`
`158`	`165`	`<a href="https://tinkerwell.app/">`
`159`	`166`	`<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)!`
`162`	`169`	`The development of this package is supported by [Tinkerwell](https://tinkerwell.app/).`
`163`	`170`
`164`	`171`
`165`		`-## Contributing`
	`172`	`+# Contributing`
`166`	`173`
`167`	`174`	`Please see [CONTRIBUTING](CONTRIBUTING.md) for details.`
`168`	`175`
`169`		`-## Security`
	`176`	`+# Security`
`170`	`177`
`171`	`178`	`If you discover any security related issues, please email hello@dianaweb.dev instead of using the issue tracker.`
`172`	`179`
`173`		`-## Credits`
	`180`	`+# Credits`
`174`	`181`
`175`	`182`	`- [Diana Scharf](https://github.com/mechelon)`
`176`	`183`	`- [Johannes Güntner](https://github.com/johguentner)`
`@@ -179,6 +186,6 @@ If you discover any security related issues, please email hello@dianaweb.dev ins`
`179`	`186`	`<img src="https://5amco.de/images/5am.png" width="200" height="200">`
`180`	`187`	`</p>`
`181`	`188`
`182`		`-## License`
	`189`	`+# License`
`183`	`190`
`184`	`191`	`The MIT License (MIT). Please see [License File](LICENSE.md) for more information.`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit ee3f9ca

File tree

1 file changed

1 file changed

`‎README.md`

0 commit comments