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 · 9fd8b2d · 9fd8b2d
1 parent 60c9e1b
commit 9fd8b2d
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,14 @@
+# API Platform - JSON:API
+
+The [JSON:API](https://jsonapi.org/) component of the [API Platform](https://api-platform.com) framework.
+
+JSON:API is a popular specification for building APIs in JSON.
+
+[Documentation](https://api-platform.com/docs/core/content-negotiation/)
+
+> [!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).