diff --git a/README.md b/README.md index b70043c9f..7cd42b518 100644 --- a/README.md +++ b/README.md @@ -4,55 +4,55 @@ Trigger.dev logo + +## The background jobs framework for Next.js + +[Discord](https://discord.gg/bpVDSjcG) | [Website](https://trigger.dev) | [Issues](https://github.com/triggerdotdev/trigger.dev/issues) | [Docs](https://trigger-docs.mintlify.app/documentation/introduction) [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/triggerdotdev.svg?style=social&label=Follow%20%40trigger.dev)](https://twitter.com/triggerdotdev) [![GitHub Repo stars](https://img.shields.io/github/stars/triggerdotdev/trigger.dev?style=social)](https://github.com/triggerdotdev/trigger.dev) - -# **The background jobs framework for Next.js** - +# About Trigger.dev Create long-running jobs directly in your codebase with features like API integrations, webhooks, scheduling and delays. -### Developer-first features +### Long running Jobs on serverless -#### 1. Long running Jobs on serverless - -Reliably run Jobs and don’t worry about function timeouts, we handle those for you. +Reliably run jobs and don’t worry about function timeouts, we handle those for you. - Auto-resume after a function timeout - Auto-resume after a server outage - Add delays of up to a year -#### 2. In your codebase +### In your codebase Create Jobs where they belong: in your codebase. Version control, localhost, test, review, and deploy like you're already used to. -#### 3. Secure by design +### Secure by design We only receive Triggers and the data you choose to send to us. You can even completely self-host the entire platform. -#### 4. Don't worry about deployment +### Don't worry about deployment Just use our SDK to write Jobs in your Next.js codebase. There's nothing extra to deploy and no CI to configure, your Jobs just connect to our cloud. Or you can always self-host. -#### 5. Full Visibility of every job run +### Full visibility of every job run View every Task in every Run so you can tell exactly what happened. ![image](https://www.trigger.dev/build/_assets/web-app-2QFKXFLW.png) -#### 6. Built in integrations +### Built-in integrations Easily integrate with hundreds of third-party APIs – including your own. Use API keys (which never leave your server) or let us handle OAuth for you. Install our integration packages and easily subscribe to webhooks and perform common tasks, or you can easily use your existing favorite Node.JS SDKs and get resumability and idempotency through our `runTask` function. -#### 7. Trigger.dev Connect (coming soon) +### Trigger.dev Connect (coming soon) -Easily add integrations for your users (section TBD)/ +Easily add integrations for your users. -## Documentation +# Getting started -View our [docs](https://trigger-docs.mintlify.app/documentation/introduction) for (in)complete documentation. +Visit our docs [here](https://trigger-docs.mintlify.app/documentation/introduction). ## Self-host