Skip to content

Commit a6de3f0

Browse files
D-K-Pericallam
andauthoredOct 14, 2024
README updates (#1408)
* Main README edits * SDK readme edits * CLI readme edits * Create cool-keys-sit.md --------- Co-authored-by: Eric Allam <eric@trigger.dev>
1 parent 1c80a74 commit a6de3f0

File tree

4 files changed

+75
-50
lines changed

4 files changed

+75
-50
lines changed
 

‎.changeset/cool-keys-sit.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"trigger.dev": patch
3+
"@trigger.dev/sdk": patch
4+
---
5+
6+
README updates

‎README.md

+21-6
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,20 @@
1515

1616
## About Trigger.dev
1717

18-
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.
18+
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.
1919

20-
#### Features:
20+
### Key features:
2121

2222
- JavaScript and TypeScript SDK
2323
- Write reliable code by default
24+
- No timeouts
25+
- Retries (with exponential backoff)
26+
- Queues and concurrency controls
27+
- Schedules and crons
28+
- Full Observability; logs, live trace views, advanced filtering
29+
- Custom alerts, get notified by email, Slack or webhooks
2430
- No infrastructure to manage
31+
- Elastic (scaling)
2532
- Works with your existing tech stack
2633

2734
## In your codebase
@@ -45,7 +52,7 @@ export const helloWorld = task({
4552

4653
## Deployment
4754

48-
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).
55+
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.
4956

5057
## Environments
5158

@@ -59,11 +66,19 @@ View every task in every run so you can tell exactly what happened. We provide a
5966

6067
# Getting started
6168

62-
Visit our docs [here](https://trigger.dev/docs/v3/introduction) for a full guide on how to get started with Trigger.dev.
69+
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.
6370

64-
## Self-host
71+
### Useful links:
6572

66-
If you prefer to self-host, you can follow our [self-hosting guide](https://trigger.dev/docs/v3/open-source-self-hosting#overview).
73+
- [Quick start](https://trigger.dev/docs/quick-start) - get up and running in minutes
74+
- [How it works](https://trigger.dev/docs/v3/how-it-works) - understand how Trigger.dev works under the hood
75+
- [Guides and examples](https://trigger.dev/docs/guides/introduction) - walk-through guides and code examples for popular frameworks and use cases
76+
77+
## Self-hosting
78+
79+
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).
80+
81+
We also have a dedicated self-hosting channel in our [Discord server](https://trigger.dev/discord) for support.
6782

6883
## Development
6984

‎packages/cli-v3/README.md

+16-43
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,19 @@ Note: this only works with Trigger.dev v3 projects and later. For older projects
66

77
Trigger.dev is an open source platform that makes it easy to create event-driven background tasks directly in your existing project.
88

9-
## Usage
10-
11-
### Login
12-
13-
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.
14-
15-
```sh
16-
npx trigger.dev@latest login
17-
```
18-
19-
| Option | Short option | Description |
20-
| ----------- | ------------ | -------------------------------------------------------------------- |
21-
| `--api-url` | `-a` | Set the API URL for Trigger.dev, defaults to https://api.trigger.dev |
22-
23-
### Update
24-
25-
Will update all of your @trigger.dev packages in your package.json to the latest version.
26-
27-
```sh
28-
npx trigger.dev@latest update
29-
```
30-
31-
You can pass the path to the folder that your package.json file lives in:
32-
33-
```sh
34-
npx trigger.dev@latest update ./myapp
35-
```
36-
37-
| Option | Short option | Description |
38-
| ------ | ------------ | ---------------------------------------------------------- |
39-
| `--to` | `-t` | The version to update to (ex: 2.1.4), defaults to "latest" |
40-
41-
### Who Am I?
42-
43-
Shows the current user that is logged in.
44-
45-
```sh
46-
npx trigger.dev@latest whoami
47-
```
48-
49-
| Option | Short option | Description |
50-
| ----------- | ------------ | -------------------------------------------------------------------- |
51-
| `--api-url` | `-a` | Set the API URL for Trigger.dev, defaults to https://api.trigger.dev |
9+
## Commands
10+
11+
| Command | Description |
12+
| :------------------------------------------------------------------- | :----------------------------------------------------------------- |
13+
| [login](https://trigger.dev/docs/cli-login-commands) | Login with Trigger.dev so you can perform authenticated actions. |
14+
| [init](https://trigger.dev/docs/cli-init-commands) | Initialize your existing project for development with Trigger.dev. |
15+
| [dev](https://trigger.dev/docs/cli-dev-commands) | Run your Trigger.dev tasks locally. |
16+
| [deploy](https://trigger.dev/docs/cli-deploy-commands) | Deploy your Trigger.dev v3 project to the cloud. |
17+
| [whoami](https://trigger.dev/docs/cli-whoami-commands) | Display the current logged in user and project details. |
18+
| [logout](https://trigger.dev/docs/cli-logout-commands) | Logout of Trigger.dev. |
19+
| [list-profiles](https://trigger.dev/docs/cli-list-profiles-commands) | List all of your CLI profiles. |
20+
| [update](https://trigger.dev/docs/cli-update-commands) | Updates all `@trigger.dev/*` packages to match the CLI version. |
21+
22+
## Support
23+
24+
If you have any questions, please reach out to us on [Discord](https://trigger.dev/discord) and we'll be happy to help.

‎packages/trigger-sdk/README.md

+32-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
1+
<div align="center">
2+
<picture>
3+
<source media="(prefers-color-scheme: dark)" srcset="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/a45d1fa2-0ae8-4a39-4409-f4f934bfae00/public">
4+
<source media="(prefers-color-scheme: light)" srcset="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/3f5ad4c1-c4c8-4277-b622-290e7f37bd00/public">
5+
<img alt="Trigger.dev logo" src="https://imagedelivery.net/3TbraffuDZ4aEf8KWOmI_w/a45d1fa2-0ae8-4a39-4409-f4f934bfae00/public">
6+
</picture>
7+
8+
### Open source background jobs with no timeouts
9+
10+
[Discord](https://trigger.dev/discord) | [Website](https://trigger.dev) | [Issues](https://github.com/triggerdotdev/trigger.dev/issues) | [Docs](https://trigger.dev/docs)
11+
12+
[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/triggerdotdev.svg?style=social&label=Follow%20%40trigger.dev)](https://twitter.com/triggerdotdev)
13+
14+
</div>
15+
116
# Official TypeScript SDK for Trigger.dev
217

3-
View the full documentation for the [here](https://trigger.dev/docs)
18+
The Trigger.dev SDK is a TypeScript/JavaScript library that allows you to define and trigger tasks in your project.
19+
20+
## About
21+
22+
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.
23+
24+
## Getting started
25+
26+
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.
27+
28+
## SDK usage
29+
30+
For more information on our SDK, refer to our [docs](https://trigger.dev/docs/introduction).
31+
32+
## Support
33+
34+
If you have any questions, please reach out to us on [Discord](https://trigger.dev/discord) and we'll be happy to help.

0 commit comments

Comments
 (0)
Please sign in to comment.