Repository navigation
docs: lead the README with durable workflows and trim prerequisites - #1887
Conversation
Signed-off-by: Samantha Coyle <sam@diagrid.io>
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues block the README updates to workflow discovery, prerequisites, and dependency guidance.
No open issues 🎉
What changed in this PR
Updates the README to introduce the Java SDK’s capabilities with an emphasis on durable workflows and distinguish application prerequisites from SDK development tools.
Changes:
- Adds a Workflows section linking to documentation and examples.
- Simplifies prerequisites and moves contributor tooling guidance under Development.
- Adds workflows to core BOM dependency examples and clarifies dependency version management.
| File | Description |
|---|---|
| README.md | Improves onboarding, workflow discovery, dependency examples, and development setup guidance. |
Review effort: Balanced
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1887 +/- ##
=========================================
Coverage 80.63% 80.63%
Complexity 2850 2850
=========================================
Files 275 275
Lines 8459 8459
Branches 911 911
=========================================
Hits 6821 6821
Misses 1272 1272
Partials 366 366 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
@holopin-bot @sicoyle sdk-badge Thank you! Here's a digital badge as a small token of appreciation. |
|
Congratulations @sicoyle, the maintainer of this repository has issued you a badge! Here it is: https://holopin.io/claim/cmvzqbt8y0003jq07xilm68js This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account. |
The README now opens with what the Java SDK covers and adds a Workflows section with links to the docs and examples. The prerequisites are cut down to JDK 17, Maven or Gradle and the Dapr CLI, and
dapr-sdk-workflowsis added to the BOM examples. Before this, the README listed features without context and sent new users through a long IDE setup list.Tested by checking every link, and by checking the dependency snippets against the published BOM.
🤖 Generated with Claude Code