@visitscotland/component-library 1.0.0

package/README.md

@@ -0,0 +1,31 @@
+# VisitScotland Component Library
+
+This is the repository for the **VisitScotland Component Library** which contains all the components that can be used to build user interfaces for VisitScotland.
+
+## Getting started
+
+Clone the repository then install the package:
+
+```sh
+yarn install
+```
+To set up a development environment, you will need to create a .env file with the necessary environment variables then you can run Storybook with this command:
+
+```sh
+yarn storybook
+```
+
+## Installation
+The component library can be installed via NPM to be used in your project.
+
+To install the VisitScotland Component Library in your project, run the following command using npm:
+
+```sh
+npm install @visitscotland/component-library
+```
+
+If using Yarn, use the following command instead:
+
+```sh
+yarn add @visitscotland/component-library
+```