Merge pull request #164 from citizensadvice/release/v1-0-0

Release: v1.0.0
citizensadvice · Mar 7, 2019 · 0630402 · 0630402
2 parents f9fa5c9 + e51eb11
commit 0630402
Show file tree

Hide file tree

Showing 57 changed files with 179 additions and 197 deletions.
diff --git a/README.md b/README.md
@@ -23,47 +23,10 @@ We also make use of Docker to make sure we avoid the "it works on my machine" st
 
 ## Framework guide
 
-### Getting started
-
-Firstly we need to introduce **ALL** packages available for installation:
-
-| Name                                          | Type      | Description                                             |
-| --------------------------------------------- | --------- | ------------------------------------------------------- |
-| `@citizensadvice/cads-support`                | support   | System-wide global variables and functions              |
-| `@citizensadvice/cads-typography`             | generic   | Generic typographic styling                             |
-| `@citizensadvice/cads-links`                  | generic   | Generic links styles                                    |
-| `@citizensadvice/cads-tables`                 | generic   | Generic table styling                                   |
-| `@citizensadvice/cads-wrapper`                | object    | Component for container elements at a set width         |
-| `@citizensadvice/cads-grid`                   | object    | Custom grid system                                      |
-| `@citizensadvice/cads-list`                   | object    | Component for creating lists                            |
-| `@citizensadvice/cads-global-header`          | component | System-wide global header                               |
-| `@citizensadvice/cads-global-footer`          | component | System-wide global footer                               |
-| `@citizensadvice/cads-buttons`                | component | Custom button components                                |
-| `@citizensadvice/cads-button-container`       | component | Component for holding buttons                           |
-| `@citizensadvice/cads-blockquote`             | component | Custom styles for blockquotes                           |
-| `@citizensadvice/cads-section-nav`            | component | Side navigation component styling                       |
-| `@citizensadvice/cads-form-elements`          | component | Support tool for `form-` components                     |
-| `@citizensadvice/cads-form-fieldsets`         | component | Custom styling for form elements                        |
-| `@citizensadvice/cads-form-inputs`            | component | Custom styling for form elements                        |
-| `@citizensadvice/cads-form-labels`            | component | Custom styling for form elements                        |
-| `@citizensadvice/cads-form-textareas`         | component | Custom styling for form elements                        |
-| `@citizensadvice/cads-form-selects`           | component | Custom styling for form elements                        |
-| `@citizensadvice/cads-form-radios-checkboxes` | component | Custom styling for form elements                        |
-| `@citizensadvice/cads-well`                   | component | Component for separating chunks of content              |
-| `@citizensadvice/cads-icons`                  | utility   | Icon system                                             |
-| `@citizensadvice/cads-line-limit`             | utility   | Helper classes for limiting line length                 |
-| `@citizensadvice/cads-positioning`            | utility   | Helper classes for positioning elements                 |
-| `@citizensadvice/cads-spacing`                | utility   | Helper classes for spacing elements correctly           |
-| `@citizensadvice/cads-charwidth`              | utility   | Helper classes for setting character limits on elements |
-
-> More detail of each package can be seen in each packages own `README.md`.
-
 ### Installation
 
-Once you've decided on the package(s) you need, run:
-
 ```shell
-$ npm install @citizensadvice/cads-[package-name]
+$ npm install @citizensadvice/cads
 ```
 
 ### Folder structure
@@ -95,17 +58,14 @@ For completeness, we've included an output `.css` file for each component. This
 #### `lib/`
 
 This directory contains the source files that can be compiled using `sass` during your build process.
-We're making use of the ideas of ["ITCSS"](https://www.xfive.co/blog/itcss-scalable-maintainable-css-architecture/), a methodology from [Harry Roberts](https://csswizardry.com/), which can be better undertood by reading the `@citizensadvice/cads-system` `README.md`.
 
 ### Usage
 
 Now that you've `npm install` the packages into your `node_modules`, link to them like you would any other `scss` file.
 
 ```scss
-@import "@citizensadvice/cads-button-container";
-@import "@citizensadvice/cads-buttons";
+@import "@citizensadvice/cads";
 ...
-```
 
 > Be sure to add `node_modules` to your included-paths for the above to work correctly.
 
@@ -282,7 +242,7 @@ Rewrite the repo README to include setup information around the framework.
 You'll make many different types of change to the codebase over time but most changes can be categorised under one of the following types. Make use of one of these when writing your commit messages.
 
 | Issue type | Description                                                                   |
-| ---------- | ----------------------------------------------------------------------------- |
+|------------|-------------------------------------------------------------------------------|
 | `feat`     | a new feature                                                                 |
 | `fix`      | a bug fix                                                                     |
 | `docs`     | changes to documentation                                                      |

diff --git a/lerna.json b/lerna.json
@@ -2,7 +2,7 @@
   "packages": [
     "packages/*"
   ],
-  "version": "0.0.0",
+  "version": "1.0.0",
   "npmClient": "yarn",
   "useWorkspaces": true
 }
diff --git a/packages/background-colors/package.json b/packages/background-colors/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/background-colors",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "utility"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/background-position/package.json b/packages/background-position/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/background-position",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "utility"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/background-size/package.json b/packages/background-size/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/background-size",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "utility"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/border-colors/package.json b/packages/border-colors/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/border-colors",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "utility"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/border-radius/package.json b/packages/border-radius/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/border-radius",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "utility"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/border-style/package.json b/packages/border-style/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/border-style",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "utility"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/border-width/package.json b/packages/border-width/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/border-width",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "utility"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/borders/package.json b/packages/borders/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/borders",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "utility"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/box-sizing/package.json b/packages/box-sizing/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/box-sizing",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "utility"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/buttons/package.json b/packages/buttons/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/buttons",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "module"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/cads/package.json b/packages/cads/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/cads",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "meta"
@@ -14,10 +14,10 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/core": "^0.0.0",
-    "@citizensadvice/typography": "^0.0.0",
-    "@citizensadvice/forms": "^0.0.0",
-    "@citizensadvice/rich-content": "^0.0.0"
+    "@citizensadvice/core": "^1.0.0",
+    "@citizensadvice/forms": "^1.0.0",
+    "@citizensadvice/rich-content": "^1.0.0",
+    "@citizensadvice/typography": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/clearfix/package.json b/packages/clearfix/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/clearfix",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "utility"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/core",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "meta"
@@ -14,9 +14,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0",
-    "@citizensadvice/normalize": "^0.0.0",
-    "@citizensadvice/utilities": "^0.0.0"
+    "@citizensadvice/normalize": "^1.0.0",
+    "@citizensadvice/support": "^1.0.0",
+    "@citizensadvice/utilities": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/cursor/package.json b/packages/cursor/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/cursor",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "utility"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/display/package.json b/packages/display/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/display",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "utility"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/flexbox/package.json b/packages/flexbox/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/flexbox",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "utility"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",

diff --git a/packages/floats/package.json b/packages/floats/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@citizensadvice/floats",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "license": "MIT",
   "cads": {
     "package_type": "utility"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@citizensadvice/support": "^0.0.0"
+    "@citizensadvice/support": "^1.0.0"
   },
   "scripts": {
     "build": "npm-run-all -p buildcss:expanded buildcss:compressed",