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

chore: write library purpose #17

Merged
merged 1 commit into from
Jan 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Async API Symfony Bundle

The library was inspired by [nelmio/api-doc-bundle](https://github.com/nelmio/NelmioApiDocBundle); To create a code-first experience
for PHP and Symfony engineers. This piece of software enables you to document events and messages via PHP built-in Attributes.

Features
* Code-first async messages documentation
* Built-in ability to present code powered by [Async API React Component](https://github.com/asyncapi/asyncapi-react)
* Automated documentation powered by PHP Reflection

## Installation

```bash
Expand Down
Loading