Skip to content

README updates #1408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/cool-keys-sit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"trigger.dev": patch
"@trigger.dev/sdk": patch
---

README updates
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand All @@ -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

Comment on lines +73 to +76
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Great addition of "Useful links" section.

The new "Useful links" section is a valuable addition to the README. It provides easy access to essential resources for users at different stages of their Trigger.dev journey. The links to quick start, how it works, and guides and examples cover all the bases for new and experienced users alike.

However, there's a small structural issue to address:

The "Useful links" heading is currently an h3 (###), which is inconsistent with the document structure. To maintain consistency, change it to an h2 (##). Here's the suggested fix:

-### Useful links:
+## Useful links

This change will improve the document's structure and address the Markdownlint warning about heading increments.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- [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
## Useful links
- [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

Expand Down
59 changes: 16 additions & 43 deletions packages/cli-v3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
33 changes: 32 additions & 1 deletion packages/trigger-sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
<div align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/a45d1fa2-0ae8-4a39-4409-f4f934bfae00/public">
<source media="(prefers-color-scheme: light)" srcset="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/3f5ad4c1-c4c8-4277-b622-290e7f37bd00/public">
<img alt="Trigger.dev logo" src="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/a45d1fa2-0ae8-4a39-4409-f4f934bfae00/public">
</picture>

### 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)

</div>

# 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.