Skip to content

Commit

Permalink
overview copy updates
Browse files Browse the repository at this point in the history
  • Loading branch information
maxcountryman committed Oct 27, 2024
1 parent cac3b1a commit 429d36a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 20 deletions.
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,14 @@

## 🎨 Overview

**Underway** is a framework for building robust, asynchronous background
jobs in Rust, leveraging PostgreSQL as its queuing backend. It provides a
streamlined interface for defining jobs as a series of "steps," where each
step's output becomes the input for the next. This design enables the
construction of complex, durable, and resilient workflows with ease.
**Underway** provides durable background jobs over Postgres. Jobs are composed of a sequence of one more steps. Each step takes the output of the previous step as its input. These simple workflows provide a powerful interface to common deferred work use cases.

Key Features:

- **PostgreSQL-Backed** Leverages PostgreSQL with `FOR UPDATE SKIP LOCKED` for
reliable task storage and coordination, ensuring efficient, safe
- **PostgreSQL-Backed** Leverages PostgreSQL with `FOR UPDATE SKIP LOCKED`
for reliable task storage and coordination.
- **Atomic Task Management** Enqueue tasks within your transactions and use
the worker's transaction within your tasks for atomic database
queries--ensuring consisteny.
the worker's transaction within your tasks for atomic queries.
- **Automatic Retries** Configurable retry strategies ensure tasks are
reliably completed, even after transient failures.
- **Cron-Like Scheduling** Schedule recurring tasks with cron-like
Expand Down Expand Up @@ -108,7 +103,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
})
.await?;

// Start processing enqueued tasks.
// Start processing enqueued jobs.
job.start().await??;

Ok(())
Expand Down
17 changes: 7 additions & 10 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,17 @@
//!
//! # Overview
//!
//! **Underway** is a framework for building robust, asynchronous background
//! jobs in Rust, leveraging PostgreSQL as its queuing backend. It provides a
//! streamlined interface for defining jobs as a series of "steps," where each
//! step's output becomes the input for the next. This design enables the
//! construction of complex, durable, and resilient workflows with ease.
//! **Underway** provides durable background jobs over Postgres. Jobs are
//! composed of a sequence of one more steps. Each step takes the output of the
//! previous step as its input. These simple workflows provide a powerful
//! interface to common deferred work use cases.
//!
//! Key Features:
//!
//! - **PostgreSQL-Backed** Leverages PostgreSQL with `FOR UPDATE SKIP LOCKED`
//! for reliable task storage and coordination, ensuring efficient, safe
//! concurrency.
//! for reliable task storage and coordination.
//! - **Atomic Task Management**: Enqueue tasks within your transactions and use
//! the worker's transaction within your tasks for atomic database
//! queries--ensuring consisteny.
//! the worker's transaction within your tasks for atomic queries.
//! - **Automatic Retries**: Configurable retry strategies ensure tasks are
//! reliably completed, even after transient failures.
//! - **Cron-Like Scheduling**: Schedule recurring tasks with cron-like
Expand Down Expand Up @@ -93,7 +90,7 @@
//! })
//! .await?;
//!
//! // Start processing enqueued tasks.
//! // Start processing enqueued jobs.
//! job.start().await??;
//!
//! Ok(())
Expand Down

0 comments on commit 429d36a

Please sign in to comment.