From 8c8bca7c0a0e81b677b4449aaab8d4161d5a19c0 Mon Sep 17 00:00:00 2001 From: Clark Winkelmann Date: Thu, 18 Mar 2021 18:56:54 +0100 Subject: [PATCH] Documentation for date seed --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d6abced..28a777a 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,10 @@ If you do not create new discussions, random existing discussions will be picked A new button is added on discussions if you want to generate replies to that discussion only. -The script can be called via the API at `/api/fake-data` with parameters `user_count`, `discussion_count` and `posts_count`. +The date seed is made of two options: start date will be parsed by `Carbon::parse`, so it accepts dates in many formats (example `2021-01-01 15:00:00`) as well as human time (example `2 days ago`). +Date interval is in seconds. + +The script can be called via the API at `/api/fake-data` with parameters `user_count`, `discussion_count`, `posts_count`, `date_start` and `date_interval`. If you pass zero for users or discussions, you can provide `user_ids` and/or `discussion_ids` to restrict which users/discussions can be picked. `tag_ids` can be used to specify an array of tags to apply to all created discussions.