add readme

vikejs · Dec 25, 2023 · a264f48 · a264f48
1 parent 7b25d11
commit a264f48
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/packages/vike-angular/README.md b/packages/vike-angular/README.md
@@ -1 +1,12 @@
-TODO
+[<img src="https://vike.dev/vike-readme.svg" align="right" height="90">](https://vike.dev)
+[![npm version](https://img.shields.io/npm/v/vike-angular)](https://www.npmjs.com/package/vike-angular)
+
+# `vike-angular`
+
+Angular integration for [Vike](https://github.com/vikejs/vike).
+
+> [!NOTE]  
+> This integration is experimental. Expect things to break.
+> For integrations with React, Vue and SolidJS, see the other [`vike-*` packages](https://vike.dev/vike-packages).
+
+See [examples/](https://github.com/vikejs/vike-angular/tree/main/examples).