doc: add README files for components (#6653)

* docs: add README for components * Update README.md Co-authored-by: Antoine Bluchet <[email protected]> * Update README.md Co-authored-by: Antoine Bluchet <[email protected]> * Update README.md Co-authored-by: Antoine Bluchet <[email protected]> * remove trailing spaces * typo * better title --------- Co-authored-by: Antoine Bluchet <[email protected]>
api-platform · Sep 21, 2024 · cb4f044 · cb4f044
1 parent cd4f38e
commit cb4f044
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,15 @@
 # API Platform - Serializer
 
-The API Platform Serializer
+The Serializer component of the [API Platform](https://api-platform.com) framework.
+
+Serializes PHP objects in various API formats.
+Built on top of the Symfony Serializer component.
+
+[Documentation](https://api-platform.com/docs/core/serialization/)
+
+> [!CAUTION]
+>
+> This is a read-only sub split of `api-platform/core`, please
+> [report issues](https://github.com/api-platform/core/issues) and
+> [send Pull Requests](https://github.com/api-platform/core/pulls)
+> in the [core API Platform repository](https://github.com/api-platform/core).