Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adhocore authored Jul 22, 2018
1 parent bc65912 commit 895eade
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,16 @@
- Lightweight Cron expression parser library for PHP.
- Very fast because it bails early in case a segment doesnt match.


## Installation

```bash
composer require adhocore/cron-expr
```


## Usage

```php
use Ahc\Cron\Expression;

Expand All @@ -31,10 +35,11 @@ $expr->isCronDue('*/1 * * * *', time());
```

### Real Abbreviations
You can use real abbreviations for month and week days. eg: `JAN`, `dec`, `fri`, `SUN`

You can use real abbreviations for month and week days. eg: `JAN`, `dec`, `fri`, `SUN`

### Tags

Following tags are available and they are converted to real cron expressions before parsing:

- *@yearly* or *@annually* - every year
Expand All @@ -49,6 +54,7 @@ Following tags are available and they are converted to real cron expressions bef
- *@always* - every minute

### Modifiers

Following modifiers supported

- *Day of Month / 3rd segment:*
Expand Down

0 comments on commit 895eade

Please sign in to comment.