From 829b0196d458b486866ab45e82cceefd43ac855c Mon Sep 17 00:00:00 2001
From: Huw Wilkins <huw.wilkins@canonical.com>
Date: Mon, 1 Jul 2024 09:52:30 +1000
Subject: [PATCH] fix: commit ignored docs file

---
 .gitignore                   |  1 -
 src/docs/getting-started.mdx | 21 +++++++++++++++++++++
 2 files changed, 21 insertions(+), 1 deletion(-)
 create mode 100644 src/docs/getting-started.mdx

diff --git a/.gitignore b/.gitignore
index 4f859adf1..905295616 100644
--- 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
new file mode 100644
index 000000000..4920f7154
--- /dev/null
+++ 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).