Skip to content
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

Update README for 1.0 #1790

Merged
merged 4 commits into from
Sep 23, 2024
Merged

Update README for 1.0 #1790

merged 4 commits into from
Sep 23, 2024

Conversation

djfarrelly
Copy link
Member

@djfarrelly djfarrelly commented Sep 23, 2024

Description

Updates to information, examples, SDKs, self-hosting and system architecture for the 1.0 release.

This also aims to streamline the README for ease of reading and locating linked resources. This intentionally reduces the "how it works" copy and points to the Inngest documentation website.

Preview changes: https://github.com/inngest/inngest/tree/task/update-readme-1-0

Motivation

1.0 release

Type of change (choose one)

  • Chore (refactors, upgrades, etc.)
  • Bug fix (non-breaking change that fixes an issue)
  • Security fix (non-breaking change that fixes a potential vulnerability)
  • Docs
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality not to work as expected)

Checklist

  • I've linked any associated issues to this PR.
  • I've tested my own changes.

Check our Pull Request Guidelines

Copy link

vercel bot commented Sep 23, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
ui ⬜️ Ignored (Inspect) Visit Preview Sep 23, 2024 8:36pm

@djfarrelly djfarrelly merged commit 923860d into main Sep 23, 2024
10 of 11 checks passed
@djfarrelly djfarrelly deleted the task/update-readme-1-0 branch September 23, 2024 20:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants