From c779329c3d6a773adb7d78fd79e48916a8759b24 Mon Sep 17 00:00:00 2001 From: Benjamin Chiong <72421923+cdbenj@users.noreply.github.com> Date: Mon, 2 Nov 2020 11:05:54 +1100 Subject: [PATCH] Feature/update doc (#82) * jsdelivr instructions * update JSDelivr instructions * add a link * feat: update readme doc to introduce jsdelivr --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5639dff5..e2c88be8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # NSW Design System +[![npm version](https://badge.fury.io/js/nsw-design-system.svg)](https://badge.fury.io/js/nsw-design-system) +[![](https://data.jsdelivr.com/v1/package/npm/nsw-design-system/badge)](https://www.jsdelivr.com/package/npm/nsw-design-system) + + NSW Design system is a collection of reusable UI components used on the NSW goverment websites. See live examples of NSW Digital Design system components and guidance on how to use them on you website at [NSW Design System](https://www.digital.nsw.gov.au/digital-design-system). @@ -9,7 +13,8 @@ See live examples of NSW Digital Design system components and guidance on how to How you use the NSW Design System depends on your team's capabilities. We recommend using `npm` but also provide a downloadable starter kit which includes all the compiled assets. 1. [Installing with NPM](#installing-with-npm) - 2. [Download starter kit](#download-starterkit) + 2. [Download starter kit](#download-starter-kit) + 3. [Using JSDelivr CDN](#using-jsdelivr-cdn) ### Installing with NPM `npm` is a package manager for Node-based projects. We recommend `npm` packages because it makes it easy to update and install the design system from the command line. @@ -44,6 +49,24 @@ Some of the NSW Design System components require javascript to provide advanced ``` You might wish to copy the file into your project or reference it from `node_modules`, this will depend on your build setup. +### Using JSDelivr CDN +The bundled css and js files are also hosted in [JSDelivr](https://www.jsdelivr.com). + +You can add the files to your main html document +``` + + + ... + + + + ... + + + + +``` + ## Getting updates To be notified when there’s a new release, you can either join the [NSW Design System community](https://community.digital.nsw.gov.au/) or [watch the NSW Design System Github](https://github.com/digitalnsw/nsw-design-system)