Skip to content

Commit

Permalink
docs: 📝 update project README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dylankelly committed Jun 22, 2023
1 parent 08633ca commit d901d20
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 8 deletions.
56 changes: 48 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,62 @@
# Ripple 2.0

<img src="/docs/public/assets/img/ripple-header.png" alt="Ripple branding header made up of different decorative shapes" style="margin-top: -70px;" />
<img src="/docs/public/assets/img/ripple-header-title.png" alt="Ripple framework" style="margin-top: -70px;" />


<a href="https://vuejs.org/">
<img src="https://img.shields.io/badge/vue.js-3-brightgreen" alt="">
<a href="https://www.ripple.sdp.vic.gov.au/">
<img src="https://img.shields.io/badge/ripple_framework-docs-ef4b5e" alt="ripple docs">
</a>
<a href="https://v3.nuxtjs.org/">
<img src="https://img.shields.io/badge/nuxt-3-lightgrey" alt="">

<a href="https://www.ripple.sdp.vic.gov.au/storybook">
<img src="https://img.shields.io/badge/ripple_framework-storybook-ef4b5e" alt="ripple storybook">
</a>

<a href="https://www.npmjs.com/package/@dpc-sdp/ripple-ui-core">
<img src="https://img.shields.io/npm/dw/%40dpc-sdp/ripple-ui-core?logo=npm&logoColor=white&color=%23ef4b5e
" alt="ripple ui core npm">
</a>

# Ripple 2.0


<!-- TABLE OF CONTENTS -->
# Table of Contents
- [Ripple 2.0](#ripple-20)
- [Table of Contents](#table-of-contents)
- [About the project](#about-the-project)
- [Ripple Framework](#ripple-framework)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)

## About the project

Ripple is the presentation layer for building websites on the DPC [Single Digital Presence](https://www.vic.gov.au/single-digital-presence) platform.
Ripple is the design system for Victorian government digital products.

Ripple is a system of reusable styles, components, patterns and tools for building brand Victoria digital products. Developed by the Single Digital Presence (SDP) team within the Department of Government Services, Ripple strives to:

- make it easier for citizens to find, understand and use government information
- ensure users can easily navigate sites regardless of technical ability, location or device
- allow designers and developers to create consistent Brand Victoria digital products
- increase the speed of delivery for digital products and services

Over 50 government websites use Ripple to date, including our main vic.gov.au platform. These sites attract the visitation of millions of views per month.


### Ripple Framework

The Ripple design system consists of the design elements and components used to build websites using the Victorian government brand and Ripple _framework_, a collection of [Nuxt 3](https://www.ripple.sdp.vic.gov.au/framework/key-concepts/nuxt/) modules and [layers](https://www.ripple.sdp.vic.gov.au/framework/key-concepts/nuxt-layers) primarily used to create headless SDP websites using the [Tide Drupal CMS](https://github.com/dpc-sdp/tide).


## Documentation

See https://www.ripple.sdp.vic.gov.au/ for more information about the Ripple design system.

For information about using Ripple in SDP websites see the [Ripple Framework](https://www.ripple.sdp.vic.gov.au/framework) section.


## Contributing

_Ripple 2_ is a ground-up redevelopment using the newest versions of Vue and Nuxt. This project is still a work in progress, please [read the announcement](https://github.com/dpc-sdp/ripple-framework/discussions/69) for further details.
Please see [CONTRIBUTING.md](CONTRIBUTING.md) as well as https://www.ripple.sdp.vic.gov.au/design-system/develop/contributing/ for information about how to submit changes to Ripple.

## License

Expand Down
Binary file added docs/public/assets/img/ripple-header-title.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d901d20

Please sign in to comment.