-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Alex Sanders <alex@sndrs.dev>
- Loading branch information
1 parent
6fb4e37
commit e215f5b
Showing
2 changed files
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# `@guardian/source` | ||
|
||
<img src="assets/logo.png" 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). | ||
[![npm](https://img.shields.io/npm/v/@guardian/source)](https://www.npmjs.com/package/@guardian/source) | ||
<a href="https://guardian.github.io/storybooks/?path=/docs/source" target="_blank"><img src="https://raw.githubusercontent.com/storybooks/brand/master/badge/badge-storybook.svg"></a> | ||
|
||
## Install | ||
|
||
```sh | ||
$ pnpm add @guardian/source | ||
``` | ||
|
||
or | ||
|
||
```sh | ||
$ yarn add @guardian/source | ||
``` | ||
|
||
or | ||
|
||
```sh | ||
$ npm install @guardian/source | ||
``` | ||
|
||
> [!NOTE] | ||
> Use of the React components will require [@emotion/react](https://emotion.sh/docs/introduction#react) | ||
## Documentation | ||
|
||
Full documentation for components and foundations | ||
is available in the [Source storybook](https://guardian.github.io/storybooks/?path=/docs/source). | ||
|
||
## Contributing | ||
|
||
We welcome contributions to Source! See our [contributing](../../../docs/source/contributing.md) and [Storybook](../../../docs/source/storybook.md) docs for more info. |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.