Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sndrs committed May 23, 2024
1 parent 27c74dc commit 58be5f8
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .changeset/neat-mirrors-wash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@guardian/source': patch
---

Improve README
22 changes: 19 additions & 3 deletions libs/@guardian/source/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `@guardian/source`

<img src="assets/logo.png" height="320" width="620" >
<img src="https://github.com/guardian/csnx/blob/main/libs/@guardian/source/assets/logo.png?raw=true" height="320" width="620" >

> An NPM package containing design foundations and robust, accessible React components from the Guardian's
> [Source Design System](https://theguardian.design).
Expand Down Expand Up @@ -29,9 +29,25 @@ $ npm install @guardian/source
> [!NOTE]
> Use of the React components will require [@emotion/react](https://emotion.sh/docs/introduction#react)
## Documentation
## Usage

Full documentation is available in the [Source storybook](https://guardian.github.io/storybooks).
_Full documentation is available in the [Source storybook](https://guardian.github.ixo/storybooks)._

### `foundations`

Source design foundations (e.g. colour, spacing, typography etc) can be imported from the `foundations` subpath:

```js
import { palette } from '@guardian/source/foundations`
```
### `react-components`
A set of robust, accessible, React components can be imported from the `react-components` subpath:
```js
import { Button } from '@guardian/source/react-components`
```

## Contributing

Expand Down

0 comments on commit 58be5f8

Please sign in to comment.