Merge pull request #22 from saiichihashimoto/readme

fix(docs): readme and descriptions

.github/settings.yml

@@ -2,7 +2,7 @@
 _extends: .github
 repository:
   name: vercel-cron
-  description: TODO
+  description: Vercel Crons for local development
   private: false
 branches:
   - name: main

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Saiichi Hashimoto
+Copyright (c) 2024 Saiichi Hashimoto
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -11,4 +11,39 @@
 
 [![GitHub Sponsors](https://img.shields.io/github/sponsors/saiichihashimoto?style=flat)](https://github.com/sponsors/saiichihashimoto)
 
-TODO
+[Vercel Crons](https://vercel.com/docs/cron-jobs) for local development
+
+## Getting Started
+
+```bash
+npm install --save-dev vercel-cron
+npx vercel-cron
+# See the other options!
+npx vercel-cron --help
+```
+
+Crons will be loaded from your `vercel.json` and ping `localhost:3000`! Your config will be watched and reloaded on changes, so there's no need to restart.
+
+`process.env.CRON_SECRET` will be used to [secure your cron jobs](https://vercel.com/docs/cron-jobs/manage-cron-jobs#securing-cron-jobs). You don't need to provide this any differently than you would `next dev`: we're loading your environment variables the [same way that next does](https://www.npmjs.com/package/@next/env).
+
+## Running alongside server
+
+My favorite is [concurrently](https://www.npmjs.com/search?q=concurrently), but there are many libraries that do this.
+
+`package.json`
+
+```json
+{
+  "scripts": {
+    "dev": "concurrently npm:dev:*",
+    "dev:cron": "vercel-cron",
+    "dev:next": "next dev"
+  }
+}
+```
+
+## Differences from Vercel
+
+### Cron Expressions
+
+Under the covers, we're using [croner](https://www.npmjs.com/package/croner), which has slightly different [cron expressions](https://vercel.com/docs/cron-jobs#cron-expressions) than vercel does. Until we can find an exact validation method, vercel's suggestion is to validate expressions against [crontab guru](https://crontab.guru/).

package.json

@@ -2,7 +2,7 @@
   "$schema": "https://json.schemastore.org/package.json",
   "name": "vercel-cron",
   "version": "0.0.0-development",
-  "description": "TODO",
+  "description": "Vercel Crons for local development",
   "funding": {
     "type": "individual",
     "url": "https://github.com/sponsors/saiichihashimoto"