From 60ba0da22d2f9c37c9ecae82607dd183ed5434dd Mon Sep 17 00:00:00 2001 From: Ferror Date: Mon, 29 Jan 2024 19:28:45 +0100 Subject: [PATCH] chore: write library purpose --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 1d97a39..1864b09 100644 --- a/README.md +++ b/README.md @@ -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