You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-6
Original file line number
Diff line number
Diff line change
@@ -15,13 +15,20 @@
15
15
16
16
## About Trigger.dev
17
17
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.
19
19
20
-
#### Features:
20
+
###Key features:
21
21
22
22
- JavaScript and TypeScript SDK
23
23
- 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
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.
49
56
50
57
## Environments
51
58
@@ -59,11 +66,19 @@ View every task in every run so you can tell exactly what happened. We provide a
59
66
60
67
# Getting started
61
68
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.
63
70
64
-
##Self-host
71
+
### Useful links:
65
72
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.
Copy file name to clipboardExpand all lines: packages/cli-v3/README.md
+16-43
Original file line number
Diff line number
Diff line change
@@ -6,46 +6,19 @@ Note: this only works with Trigger.dev v3 projects and later. For older projects
6
6
7
7
Trigger.dev is an open source platform that makes it easy to create event-driven background tasks directly in your existing project.
8
8
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.
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