Skip to content

Comments

Update README.md#100

Merged
RaoulSchaffranek merged 11 commits intomasterfrom
update-readme
Feb 24, 2026
Merged

Update README.md#100
RaoulSchaffranek merged 11 commits intomasterfrom
update-readme

Conversation

@bbyalcinkaya
Copy link
Member

@bbyalcinkaya bbyalcinkaya commented Feb 2, 2026

This PR adds a polished README to introduce Komet and help developers get started quickly.

What's included:

  • Overview: Clear explanation of Komet's fuzzing and formal verification capabilities for Soroban smart contracts, and a GIF to showcase Komet in action.
  • Installation guide: Step-by-step setup using kup (our Nix-based package manager)
  • Quick start: Property test code example with structure explanation
  • Workflow guidance: When to use fuzzing vs. formal verification during development
  • Features & benefits: Highlights of Komet's testing capabilities and security guarantees
  • Documentation links: Pointers to guides, examples, and video demo
  • Roadmap: Upcoming features including advanced Soroban Wasm debugger with IDE integrations
  • Community resources: Discord, homepage, and support links

The README includes placeholder for a demo GIF (assets/komet-demo.gif) to showcase Komet in action.

@bbyalcinkaya bbyalcinkaya marked this pull request as ready for review February 6, 2026 07:07
@RaoulSchaffranek RaoulSchaffranek merged commit 608c569 into master Feb 24, 2026
11 of 12 checks passed
@RaoulSchaffranek RaoulSchaffranek deleted the update-readme branch February 24, 2026 14:04
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.

3 participants