docs: minimal documentation for ngx-web-component

ReadAlongs · May 23, 2024 · 99585b6 · 99585b6
1 parent 5434937
commit 99585b6
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 5 deletions.
diff --git a/packages/ngx-web-component/README.md b/packages/ngx-web-component/README.md
@@ -1,7 +1,5 @@
 # ngx-web-component
 
-This library was generated with [Nx](https://nx.dev).
-
-## Running unit tests
+The ngx-web-component is an Angular library wrapper around our [@readalongs/web-component](../web-component) turning it into a component for use in Angular apps.
 
-Run `nx test ngx-web-component` to execute the unit tests.
+This library was generated with [Nx](https://nx.dev).
diff --git a/packages/web-component/src/components/read-along-component/readme.md b/packages/web-component/src/components/read-along-component/readme.md
@@ -1,4 +1,4 @@
-# my-component
+# read-along