From ef1ce90f4ab380cd30b0bac532df9edd6d113982 Mon Sep 17 00:00:00 2001 From: Alexander Belanger Date: Wed, 3 Jan 2024 16:21:51 -0500 Subject: [PATCH 1/2] docs: update readme with more features --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index e3b4e9923..6ed5afd5f 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,25 @@ Hatchet has the following high-level goals: 2. **Simple to setup:** we've seen too many overengineered stacks built on a fragile task queue with overly complex infrastructure. Hatchet is designed to be simple to setup, run locally, and deploy to your own infrastructure. 3. **Flexibility when you need it:** as your application grows, you can use Hatchet to support complex, multi-step distributed workflows. Hatchet's backend is modular, allowing for customizing the implementation of the event storage API, queueing system, authentication, and more. +## Features + +**Currently implemented** + +- **✅ Declarative workflows:** use the Go SDK to define workflows, with support for timeouts and parallel execution. +- **✅ Cron schedules:** schedule workflows using a crontab syntax, like `*/15 * * * *` (every 15 minutes). +- **✅ Events API**: store events in a durable event log, with support for querying and filtering events. Define which events trigger which workflows. +- **✅ Web UI**: use the web UI to monitor and debug your workflows and events. +- **✅ Self-hostable**: MIT-licensed and Docker images available. +- **✅ Locally runnable**: see [here](https://github.com/hatchet-dev/hatchet-go-quickstart) for an example. +- **✅ Organize workflows using services**: use `worker.NewService` to organize your workflows. + +**Near-term roadmap** + +- 🚧 Helm chart for Kubernetes deployments +- 🚧 UI and CLI for creating, updating, and deleting workflows +- 🚧 Better support for parallel step execution +- 🚧 More integrations + ## Getting Started To get started, see the Hatchet documentation [here](https://docs.hatchet.run). From 5ccead5d3b0bf64d3dd3f9ae9ef1c913ffaad502 Mon Sep 17 00:00:00 2001 From: Alexander Belanger Date: Wed, 3 Jan 2024 16:25:42 -0500 Subject: [PATCH 2/2] docs: add badge for docs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6ed5afd5f..f31abf96d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![Discord](https://img.shields.io/discord/1088927970518909068?style=social&logo=discord)](https://discord.gg/ZMeUafwH89) [![License: MIT](https://img.shields.io/badge/License-MIT-purple.svg)](https://opensource.org/licenses/MIT) [![Go Reference](https://pkg.go.dev/badge/github.com/hatchet-dev/hatchet.svg)](https://pkg.go.dev/github.com/hatchet-dev/hatchet) +[![Docs](https://img.shields.io/badge/docs-docs.hatchet.run-3F16E4)](https://docs.hatchet.run) [![Discord](https://img.shields.io/discord/1088927970518909068?style=social&logo=discord)](https://discord.gg/ZMeUafwH89) [![License: MIT](https://img.shields.io/badge/License-MIT-purple.svg)](https://opensource.org/licenses/MIT) [![Go Reference](https://pkg.go.dev/badge/github.com/hatchet-dev/hatchet.svg)](https://pkg.go.dev/github.com/hatchet-dev/hatchet) ## Introduction