@scottish-government/designsystem-react 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# @scottish-government/designsystem-react
|
|
2
|
+
|
|
3
|
+
This repository contains a React implementation of the [Scottish Government Design System](https://designsystem.gov.scot/).
|
|
4
|
+
|
|
5
|
+
There is a documentation site showing what is in this implementation and how to use it here: https://designsystem-react.vercel.app/
|
|
6
|
+
|
|
7
|
+
## Feedback, help or support
|
|
8
|
+
|
|
9
|
+
If you need any help or want to give any feedback you can e-mail the Design System team at: [designsystem@gov.scot](mailto:designsystem@gov.scot).
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
We recommend installing the package using npm. The npm package includes the SG Design System as a dependency.
|
|
14
|
+
|
|
15
|
+
`npm install @scottish-government/designsystem-react`
|
|
16
|
+
|
|
17
|
+
## Run tasks
|
|
18
|
+
|
|
19
|
+
`npm run tsc`
|
|
20
|
+
Compile the source code from TypeScript/TSX into JavaScript/JSX files, located in `/dist`
|
|
21
|
+
|
|
22
|
+
`npm run test`
|
|
23
|
+
Run unit tests
|
|
24
|
+
|
|
25
|
+
`npm run coverage`
|
|
26
|
+
Run unit tests and output a coverage report, located in `/coverage`
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@scottish-government/designsystem-react",
|
|
3
3
|
"description": "A React/JSX implementation of the Scottish Government Design System",
|
|
4
|
-
"version": "0.1.
|
|
4
|
+
"version": "0.1.2",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": {
|
|
7
7
|
"name": "Scottish Government Digital Design System team",
|