Skip to content

Commit fb5a0d8

Browse files
committed
docs: update README with installation and migration instructions
1 parent 16213ef commit fb5a0d8

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,32 @@ Zap is a comprehensive calendar and scheduling system for Laravel. Manage availa
3232

3333
**Requirements:** PHP ≤8.5 • Laravel ≤12.0
3434

35+
You can install the package via composer:
36+
3537
```bash
3638
composer require laraveljutsu/zap
37-
php artisan vendor:publish --tag=zap-migrations
39+
```
40+
41+
You should publish the migration and the `config/zap.php` config file with:
42+
43+
```bash
44+
php artisan vendor:publish --provider="Zap\ZapServiceProvider"
45+
```
46+
47+
### Before Running Migrations
48+
49+
**If you are USING UUIDs**, see the [Custom Model Support](#custom-model-support) section of the docs on UUID steps, before you continue. It explains some changes you may want to make to the migrations and config file before continuing. It also mentions important considerations after extending this package's models for UUID capability.
50+
51+
If so, run the migration command:
52+
53+
```bash
3854
php artisan migrate
3955
```
4056

57+
### Note for Apps Using UUIDs/ULIDs/GUIDs
58+
59+
This package expects the primary key of your models to be an auto-incrementing int. If it is not, you may need to modify the `create_schedules_table` and `create_schedule_periods_table` migration and/or modify the default configuration. See [Custom Model Support](#custom-model-support) for more information.
60+
4161
### Setup Your Models
4262

4363
Add the `HasSchedules` trait to any Eloquent model you want to make schedulable:
@@ -51,14 +71,6 @@ class Doctor extends Model
5171
}
5272
```
5373

54-
### Note for Apps Using UUIDs/ULIDs/GUIDs
55-
56-
This package expects the primary key of your models to be an auto-incrementing int. If it is not, you may need to modify the `create_schedules_table` and `create_schedule_periods_table` migration and/or modify the default configuration. See [Custom Model Support](#custom-model-support) for more information.
57-
58-
### Before Running Migrations
59-
60-
**If you are USING UUIDs**, see the [Custom Model Support](#custom-model-support) section of the docs on UUID steps, before you continue. It explains some changes you may want to make to the migrations and config file before continuing. It also mentions important considerations after extending this package's models for UUID capability.
61-
6274
---
6375

6476
## 🧩 Core Concepts

0 commit comments

Comments
 (0)