Skip to content

Commit 2666548

Browse files
committed
Type in the initial README
1 parent e6e70d4 commit 2666548

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Change Log of `laravel-process-async`
2+
3+
## Dev (WIP)
4+
- ...

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
11
# laravel-process-async
2-
Utilize Laravel Process to run PHP code asynchronously.
2+
Utilize Laravel Processes to run PHP code asynchronously.
3+
4+
## What really is this?
5+
[Laravel Processes](https://laravel.com/docs/10.x/processes) was first introduced in Laravel 10. This library wraps around `Process::start()` to let you execute code in the background to achieve async, albeit with some caveats:
6+
- You may only execute PHP code
7+
- Restrictions from SC apply (see)
8+
- Silent execution: no built-in result-checking, check the results yourself (e.g. via database)
9+
10+
## Installation
11+
(WIP)
12+
13+
## Change log
14+
Please see `CHANGELOG.md`.
15+
16+
## Example code
17+
(WIP)
18+
19+
## Testing
20+
PHPUnit via Composer script:
21+
```sh
22+
composer run-script test
23+
```

0 commit comments

Comments
 (0)