From 40ac8c1688cc7ae9e9f524c222cd55c1ea2bb4df Mon Sep 17 00:00:00 2001
From: Adam Laki <info@adamlaki.com>
Date: Fri, 1 Mar 2024 20:40:22 +0100
Subject: [PATCH] Update readme

---
 README.md | 40 +++++++++++++++++++++++++++++++---------
 1 file changed, 31 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index c0f7fc2..91fcfd6 100644
--- a/README.md
+++ b/README.md
@@ -14,25 +14,47 @@
 
 [![Netlify Status](https://api.netlify.com/api/v1/badges/32f689b9-2e24-462f-be66-22e1233d7f9b/deploy-status)](https://app.netlify.com/sites/sprucecss/deploys)
 
-## Contributing
+## Get Up and Running
 
-1.  **Clone the repository**
+We use `eleventy --serve` and compile Sass with sass-cli with npm scripts.
 
-    ```shell
-    git clone https://github.com/conedevelopment/sprucecss-site-eleventy.git
-    ```
+1. **Clone the repository**
 
-2.  **Install the dependencies**
+2. **Install the dependencies**
 
-    Navigate into your new site’s directory and install the dependencies.
+    In the `package.json` file, you will find all of the dependencies (and scripts) to install them using the following command:
 
     ```shell
-    cd sprucecss-site-eleventy/
     npm install
     ```
 
-3.  **Start developing**
+3. **Run the development mode**
+
+    To run the development mode, use the `npm script`.   This script will also watch for changes.
 
     ```shell
     npm start
     ```
+
+4. **Run the production mode**
+
+    Before you go live, you should use the production script to compress the Sass files.
+
+    ```shell
+    npm run prod
+    ```
+
+## SCSS
+
+The project compiles the SCSS files from the `./src/scss` folder into the `./src/css` folder. The project includes [Spruce CSS](https://sprucecss.com/), which gives the styling with some [Spruce UI](https://sprucecss.com/ui/getting-started/introduction/) components.
+
+## Other Scripts
+
+- **sass:lint/sass:lint:fix** You can lint your SCSS files with [Stylelint](https://stylelint.io/) and [stylelint-config-sass-guidelines](https://github.com/bjankord/stylelint-config-sass-guidelines) preset with the `npm run sass:lint` command. Use the `npm run sass:lint:fix` command if you want automatic fixes.
+
+- **js:lint/js:lint:fix** You can also lint your JS like with Sass. For the rules, we use the Airbnb preset.
+
+## License
+
+The code is licensed under the [MIT](LICENSE).
+