Skip to content
This repository was archived by the owner on Aug 26, 2021. It is now read-only.

Commit 1a69158

Browse files
authored
Merge pull request #884 from govau/develop
Minor restructure to use GitHub documentation standards
2 parents 8eb2656 + cfaccc3 commit 1a69158

File tree

3 files changed

+24
-14
lines changed

3 files changed

+24
-14
lines changed

FAQ.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ FAQs
33

44
> This page contains frequently asked questions from our community.
55
6-
If you can’t find the answer to your question, you can email designsystem@digital.gov.au, post a message on the [community forum](https://community.digital.gov.au/c/designsystem) or join our conversation on
7-
[Slack](http://guides.service.gov.au/join-slack/).
6+
If you can’t find the answer to your question, you can email designsystem@dta.gov.au, post a message on the [community forum](https://community.digital.gov.au/c/designsystem) or join our conversation on
7+
[Slack](https://guides.service.gov.au/join-slack/).
88

99

1010
## Contents

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,29 @@ Australian Government Design System Components
1616
| https://auds.service.gov.au | https://auds.staging.service.gov.au |
1717
| | user: `auds`, pass: `auds` |
1818

19-
2019
## Contents
2120

22-
* [How to use](#how-to-use)
21+
* [Installation](#installation)
2322
* [Frequently asked questions](#frequently-asked-questions)
2423
* [Checklist and browser support](#checklist-and-browser-support)
2524
* [Modules](#modules)
2625
* [Contribute](./CONTRIBUTING.md)
2726
* [Tests](#tests)
28-
* [License](#license)
27+
* [Support](./SUPPORT.md)
28+
* [Related repositories](#related-repositories)
29+
* [License](./LICENSE)
2930

3031

3132
----------------------------------------------------------------------------------------------------------------------------------------------------------------
3233

3334

34-
## How to use
35+
## Installation
3536

37+
### Prerequisites
3638
The design system components are distributed through the [npm](https://www.npmjs.com) ecosystem and can only be installed through the `npm` command.
3739
Npm requires [node.js](https://nodejs.org/en/) and the components needs node.js 8 or higher.
3840

41+
### Installing modules
3942
To install a module make sure you have a `package.json` file in the root of your project folders. (You can generate one by running `npm init`.)
4043
Inside your working folder install any module and [pancake](https://github.com/govau/pancake/) will make sure you have all assets ready to use.
4144

@@ -620,14 +623,10 @@ npm run test
620623

621624
----------------------------------------------------------------------------------------------------------------------------------------------------------------
622625

623-
624-
## License
625-
626-
Copyright (c) Commonwealth of Australia.
627-
Licensed under [MIT](https://raw.githubusercontent.com/govau/design-system-components/master/LICENSE).
628-
626+
## Related repositories
627+
- [govau/design-system-starter](https://github.com/govau/design-system-starter)
628+
- [govau/design-system-site](https://github.com/govau/design-system-site)
629+
- [govau/design-system-sketch-file](https://github.com/govau/design-system-sketch-file)
629630

630631
**[⬆ back to top](#contents)**
631632

632-
633-
# };

SUPPORT.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Australian Government Design System - Components - Support
2+
3+
Stuck? Got an idea? There's several channels available to engage with the Design System community.
4+
5+
We'd prefer you ask your question in the open, if possible. It's likely that others have the same question - answers posted in a public forum will assist those who come after you.
6+
7+
- [Post on our Community Forum](https://community.digital.gov.au/c/designsystem)
8+
- [Join our Slack Channel](https://govau-guides.slack.com/)
9+
- [Raise a GitHub issue](https://github.com/govau/design-system-components/issues/new/choose)
10+
11+
As a last resort, you can email the core development team directly at [email protected]

0 commit comments

Comments
 (0)