@unimelb/pattern-lib-vue - npm Package Compare versions

Comparing version 3.5.6 to 3.5.7

package.json

 {
   "name": "@unimelb/pattern-lib-vue",
   "description": "A complete design system for the University of Melbourne.",
-  "version": "3.5.6",
+  "version": "3.5.7",
   "repository": {
@@ -132,2 +132,2 @@ "type": "git",
   }
-}
+}

README.md

@@ -10,14 +10,26 @@ # Pattern Library
 
-## Set-up
+## Getting started
 
-The design system requires Node.js ~6.11.3, and the latest version of [yarn](https://yarnpkg.com/en/). To set it up, run:
+The design system requires:
 
-```
+- [Node](https://nodejs.org/en/) (~6.11.3)
+- [Yarn](https://yarnpkg.com/lang/en/docs/install/) (latest version)
+
+
+```bash
+# 1. Clone the repository.
 git clone https://github.com/unimelb/pattern-lib.git
+
+# 2. Enter your newly-cloned folder.
 cd pattern-lib
+
+# 3. Copy the env file. 
 cp .env.example .env
+
+# 4. Install dependencies. Make sure yarn is installed: https://yarnpkg.com/lang/en/docs/install
 yarn
+
+# 5. Read the documentation linked below for "Setup and development".
 ```
 
-
 ## Development
@@ -30,2 +42,21 @@
 
+
+### Generator
+
+This project includes generators to speed up common development tasks. Commands include:
+
+```bash
+# Generate a new component
+yarn generate component
+```
+You will then be asked for the name of the component, this will be used to create a new folder with a minimal component layout and story
+
+```bash
+# Generate a new view component
+yarn generate story
+```
+You will need to select the component from the list of folders, then confirm the selection by selecting `choose this directory`. You will then be asked to give the story a name.
+
+> **Note** This requires some special comments are added in the stories/index.js file. If it doesn't work make sure the comments are the same as in the template directory
+
 ### Targets
@@ -70,24 +101,3 @@
 
-### Generator
 
-#### Components
-
-New components can be scaffolded by running:
-
-- `yarn generate component`
-
-You will then be asked for the name of the component, this will be used to create a new folder with a minimal component layout and story.
-
-
-#### Stories
-
-New stories can be scaffolded too by running:
-
-- `yarn generate story`
-
-You will need to select the component from the list of folders, then confirm the selection by selecting `choose this directory`. You will then be asked to give the story a name.
-
-> **Note** This requires some special comments are added in the stories/index.js file. If it doesn't work make sure the comments are the same as in the template directory
-
-
 ## Release process
@@ -94,0 +104,0 @@

No alert changes

Improved metrics

Total package byte prevSize

196367

increased by0.17%

Number of lines in readme file

159

increased by6.71%

No dependency changes