Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update source readme #1480

Merged
merged 1 commit into from
May 23, 2024
Merged

update source readme #1480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/neat-mirrors-wash.md
View file
Open in desktop
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
View file
Open in desktop
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