diff --git a/README.md b/README.md index d2d622760..fba8fbe2a 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Twitter](https://img.shields.io/twitter/url/https/twitter.com/triggerdotdev.svg?style=social&label=Follow%20%40trigger.dev)](https://twitter.com/triggerdotdev) ![YouTube Channel Subscribers](https://img.shields.io/youtube/channel/subscribers/UCu-PdxpWtIrrd7vW0N5T6ZA?style=social) ![GitHub Repo stars](https://img.shields.io/github/stars/triggerdotdev/trigger.dev?style=social) -# **Trigger.dev** +# **πŸ›Ž Trigger.dev** [Website](https://trigger.dev) | [Community](https://github.com/triggerdotdev/jsonhero-web) | [Docs](https://docs.trigger.dev) @@ -11,23 +11,23 @@ Trigger.dev is an open source platform that makes it easy for developers to crea   -# **Features:** +# **⭐️ Features:** -- Easily subscribe to [webhooks](https://docs.trigger.dev/triggers/webhooks) - β€”they work locally without tunnelling. -- Fire your own [custom events](https://docs.trigger.dev/triggers/custom-events)β€”a single event can trigger multiple workflows. -- [Schedule workflows](https://docs.trigger.dev/triggers/scheduled)β€”easily repeat tasks or use CRON syntax for advanced cases. -- Add [long delays](https://docs.trigger.dev/functions/delays) inside workflows (up to a year) and they will pick up where they left off. -- When your server goes down [it’s not a problem](https://docs.trigger.dev/guides/resumability), workflows will reconnect and continue. -- [View every step of every run](https://docs.trigger.dev/functions/viewing-runs), with data, previews and errors. -- Connect to and authenticate with APIs using our custom integrations. -- If you have a custom use case, we support [Fetch for calling any HTTP endpoint](https://docs.trigger.dev/functions/fetch) or [webhooks](https://docs.trigger.dev/triggers/webhooks) for subscribing to events from APIs. -- All API calls are automatically retried with exponential back off. -- TypeScript SDK, so whether you’re using JavaScript or TypeScript you will have a great experience. +- πŸ‘‚ Easily subscribe to [webhooks](https://docs.trigger.dev/triggers/webhooks) + β€” they work locally without tunnelling. +- πŸ”₯ Fire your own [custom events](https://docs.trigger.dev/triggers/custom-events)β€”a single event can trigger multiple workflows. +- πŸ“† [Schedule workflows](https://docs.trigger.dev/triggers/scheduled)β€”easily repeat tasks or use CRON syntax for advanced cases. +- 🚦 Add [long delays](https://docs.trigger.dev/functions/delays) inside workflows (up to a year) and they will pick up where they left off. +- 🀝 When your server goes down [it’s not a problem](https://docs.trigger.dev/guides/resumability), workflows will reconnect and continue. +- πŸͺ§ [View every step of every run](https://docs.trigger.dev/functions/viewing-runs), with data, previews and errors. +- πŸ‘‹ Connect to and authenticate with APIs using our custom integrations. +- πŸš— If you have a custom use case, we support [Fetch for calling any HTTP endpoint](https://docs.trigger.dev/functions/fetch) or [webhooks](https://docs.trigger.dev/triggers/webhooks) for subscribing to events from APIs. +- πŸ“‘ All API calls are automatically retried with exponential back off. +- πŸ˜€ TypeScript SDK, so whether you’re using JavaScript or TypeScript you will have a great experience.   -# **Documentation:** +# **🌱 Documentation:** - [Getting Started with Trigger.dev](https://docs.trigger.dev/getting-started) - Example workflows @@ -48,7 +48,7 @@ Trigger.dev is an open source platform that makes it easy for developers to crea   -# **Quick start guide** +# **πŸƒβ€β™€οΈ Quick start guide** ### **1. Sign up at [trigger.dev](https://app.trigger.dev) and create a new organization.** @@ -231,13 +231,13 @@ await sendEvent(uuidv4(), {   -# **Running Trigger.dev locally:** +# **🏠 Running Trigger.dev locally:** To run Trigger.dev locally, [follow these steps](https://github.com/triggerdotdev/trigger.dev/blob/main/DEVELOPMENT.md).   -# **Contributing:** +# **πŸ‘ Contributing:** We are open source and love contributions! @@ -246,13 +246,13 @@ We are open source and love contributions!   -# **Self-hosting guide:** +# **πŸ§˜β€β™‚οΈ Self-hosting guide:** _coming soon..._   -# **Support & contact:** +# **πŸ“§ Support & contact:** - Join our [Discord community](https://discord.gg/JtBAxBr2m3) - If you have any other questions, get in touch at [hello@trigger.dev](mailto:hello@trigger.dev)