fix: commit ignored docs file

canonical · Jun 30, 2024 · 829b019 · 829b019
1 parent a23dc11
commit 829b019
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,5 @@
 node_modules
 dist
-docs
 .env.local
 .DS_Store
 .idea

diff --git a/src/docs/getting-started.mdx b/src/docs/getting-started.mdx
@@ -0,0 +1,21 @@
+This package provides [React](https://reactjs.org/) components for [Vanilla Framework](http://vanillaframework.io). In addition to the components, the library also provides a set of [React Hooks](https://reactjs.org/docs/hooks-intro.html).
+
+## Install
+
+```shell
+yarn add @canonical/react-components
+```
+
+Or if you use NPM:
+
+```shell
+npm install @canonical/react-components
+```
+
+## Issues
+
+Please file any issues at [GitHub](https://github.com/canonical-web-and-design/react-components/issues).
+
+## Contributing
+
+The source can be found on [GitHub](https://github.com/canonical-web-and-design/react-components).