From a1abeafa5ae2e7a64564d38d32033116c35da739 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Mon, 14 Oct 2024 16:20:56 +0100 Subject: [PATCH 1/4] Main README edits --- README.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0f512e33a8..4e3416c4aa 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,20 @@ ## About Trigger.dev -Trigger.dev is an open source platform and SDK which allows you to create long-running background jobs with no timeouts. Write normal async code, deploy, and never hit a timeout. +Trigger.dev is an open source platform and SDK which allows you to create long-running background jobs. Write normal async code, deploy, and never hit a timeout. -#### Features: +### Key features: - JavaScript and TypeScript SDK - Write reliable code by default +- No timeouts +- Retries (with exponential backoff) +- Queues and concurrency controls +- Schedules and crons +- Full Observability; logs, live trace views, advanced filtering +- Custom alerts, get notified by email, Slack or webhooks - No infrastructure to manage +- Elastic (scaling) - Works with your existing tech stack ## In your codebase @@ -45,7 +52,7 @@ export const helloWorld = task({ ## Deployment -Use our SDK to write tasks in your codebase. There's no infrastructure to manage, your tasks automatically scale and connect to our cloud. Or you can always [self-host](https://trigger.dev/docs/v3/open-source-self-hosting#overview). +Use our SDK to write tasks in your codebase. There's no infrastructure to manage, your tasks automatically scale and connect to our cloud. Or you can always self-host. ## Environments @@ -59,11 +66,19 @@ View every task in every run so you can tell exactly what happened. We provide a # Getting started -Visit our docs [here](https://trigger.dev/docs/v3/introduction) for a full guide on how to get started with Trigger.dev. +The quickest way to get started is to create an account and project in our [web app](https://cloud.trigger.dev), and follow the instructions in the onboarding. Build and deploy your first task in minutes. -## Self-host +### Useful links: -If you prefer to self-host, you can follow our [self-hosting guide](https://trigger.dev/docs/v3/open-source-self-hosting#overview). +- [Quick start](https://trigger.dev/docs/quick-start) - get up and running in minutes +- [How it works](https://trigger.dev/docs/v3/how-it-works) - understand how Trigger.dev works under the hood +- [Guides and examples](https://trigger.dev/docs/guides/introduction) - walk-through guides and code examples for popular frameworks and use cases + +## Self-hosting + +If you prefer to self-host Trigger.dev, you can follow our [self-hosting guide](https://trigger.dev/docs/v3/open-source-self-hosting#overview). + +We also have a dedicated self-hosting channel in our [Discord server](https://trigger.dev/discord) for support. ## Development From b3f4a73bd8a60bf7b1843ee84d7f8e20f4efd449 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Mon, 14 Oct 2024 16:21:04 +0100 Subject: [PATCH 2/4] SDK readme edits --- packages/trigger-sdk/README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/packages/trigger-sdk/README.md b/packages/trigger-sdk/README.md index d3ea2f35f9..c53b5cb906 100644 --- a/packages/trigger-sdk/README.md +++ b/packages/trigger-sdk/README.md @@ -1,3 +1,34 @@ +
+ + + + Trigger.dev logo + + +### Open source background jobs with no timeouts + +[Discord](https://trigger.dev/discord) | [Website](https://trigger.dev) | [Issues](https://github.com/triggerdotdev/trigger.dev/issues) | [Docs](https://trigger.dev/docs) + +[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/triggerdotdev.svg?style=social&label=Follow%20%40trigger.dev)](https://twitter.com/triggerdotdev) + +
+ # Official TypeScript SDK for Trigger.dev -View the full documentation for the [here](https://trigger.dev/docs) +The Trigger.dev SDK is a TypeScript/JavaScript library that allows you to define and trigger tasks in your project. + +## About + +Trigger.dev is an open source platform and SDK which allows you to create long-running background jobs. Write normal async code, deploy, and never hit a timeout. + +## Getting started + +The quickest way to get started is to create an account in our [web app](https://cloud.trigger.dev), create a new project and follow the instructions in the onboarding. Build and deploy your first task in minutes. + +## SDK usage + +For more information on our SDK, refer to our [docs](https://trigger.dev/docs/introduction). + +## Support + +If you have any questions, please reach out to us on [Discord](https://trigger.dev/discord) and we'll be happy to help. From 49365ecfb8dad2e54ed17f1164d90d144bd9d5ba Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Mon, 14 Oct 2024 16:23:44 +0100 Subject: [PATCH 3/4] CLI readme edits --- packages/cli-v3/README.md | 59 +++++++++++---------------------------- 1 file changed, 16 insertions(+), 43 deletions(-) diff --git a/packages/cli-v3/README.md b/packages/cli-v3/README.md index 453099f006..de0e576f3e 100644 --- a/packages/cli-v3/README.md +++ b/packages/cli-v3/README.md @@ -6,46 +6,19 @@ Note: this only works with Trigger.dev v3 projects and later. For older projects Trigger.dev is an open source platform that makes it easy to create event-driven background tasks directly in your existing project. -## Usage - -### Login - -Logs that machine into Trigger.dev by creating a new Personal Access Token and storing it on the local machine. Once you're logged in you can perform the other actions below. - -```sh -npx trigger.dev@latest login -``` - -| Option | Short option | Description | -| ----------- | ------------ | -------------------------------------------------------------------- | -| `--api-url` | `-a` | Set the API URL for Trigger.dev, defaults to https://api.trigger.dev | - -### Update - -Will update all of your @trigger.dev packages in your package.json to the latest version. - -```sh -npx trigger.dev@latest update -``` - -You can pass the path to the folder that your package.json file lives in: - -```sh -npx trigger.dev@latest update ./myapp -``` - -| Option | Short option | Description | -| ------ | ------------ | ---------------------------------------------------------- | -| `--to` | `-t` | The version to update to (ex: 2.1.4), defaults to "latest" | - -### Who Am I? - -Shows the current user that is logged in. - -```sh -npx trigger.dev@latest whoami -``` - -| Option | Short option | Description | -| ----------- | ------------ | -------------------------------------------------------------------- | -| `--api-url` | `-a` | Set the API URL for Trigger.dev, defaults to https://api.trigger.dev | +## Commands + +| Command | Description | +| :------------------------------------------------------------------- | :----------------------------------------------------------------- | +| [login](https://trigger.dev/docs/cli-login-commands) | Login with Trigger.dev so you can perform authenticated actions. | +| [init](https://trigger.dev/docs/cli-init-commands) | Initialize your existing project for development with Trigger.dev. | +| [dev](https://trigger.dev/docs/cli-dev-commands) | Run your Trigger.dev tasks locally. | +| [deploy](https://trigger.dev/docs/cli-deploy-commands) | Deploy your Trigger.dev v3 project to the cloud. | +| [whoami](https://trigger.dev/docs/cli-whoami-commands) | Display the current logged in user and project details. | +| [logout](https://trigger.dev/docs/cli-logout-commands) | Logout of Trigger.dev. | +| [list-profiles](https://trigger.dev/docs/cli-list-profiles-commands) | List all of your CLI profiles. | +| [update](https://trigger.dev/docs/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. | + +## Support + +If you have any questions, please reach out to us on [Discord](https://trigger.dev/discord) and we'll be happy to help. From f8859d225e34fef1f01f46fae121ff236a0ed9e8 Mon Sep 17 00:00:00 2001 From: Eric Allam Date: Mon, 14 Oct 2024 16:37:14 +0100 Subject: [PATCH 4/4] Create cool-keys-sit.md --- .changeset/cool-keys-sit.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/cool-keys-sit.md diff --git a/.changeset/cool-keys-sit.md b/.changeset/cool-keys-sit.md new file mode 100644 index 0000000000..7330189ad7 --- /dev/null +++ b/.changeset/cool-keys-sit.md @@ -0,0 +1,6 @@ +--- +"trigger.dev": patch +"@trigger.dev/sdk": patch +--- + +README updates