Skip to content

Commit

Permalink
docs: add quick start guide to README
Browse files Browse the repository at this point in the history
  • Loading branch information
chanceaclark committed Aug 26, 2024
1 parent f161691 commit 7eb7ff2
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion packages/big-design-patterns/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,39 @@ You can find documentation and examples on our [docs page](https://bigcommerce.g

### Quick start guide

TODO: Write the quick start guide.
Add `@bigcommerce/big-design`, `@bigcommerce/big-design-patterns` and `styled-components@5` to your project using `npm`:

```
npm install @bigcommerce/big-design @bigcommerce/big-design-patterns styled-components@5
```

or with `pnpm`:

```
pnpm add @bigcommerce/big-design @bigcommerce/big-design-patterns styled-components@5
```

Setup BigDesign as per the [Quick start guide](https://github.com/bigcommerce/big-design/tree/main/packages/big-design#quick-start-guide) and then import any pattern, such as `Page` and `Header`, to use it anywhere in your app.

```tsx
import { Panel } from '@bigcommerce/big-design';
import { AddIcon } from '@bigcommerce/big-design-icons';
import { Page, Header } from '@bigcommerce/big-design-patterns';

export default function App() {
const header = (
<Header
title="Products"
description="View and manage your products."
actions={[{ text: 'Add new', iconLeft: <AddIcon /> }]}
/>
);

return (
<Page header={header}>
<Panel header="Main content">
...
</Panel>
</Page>
);
}

0 comments on commit 7eb7ff2

Please sign in to comment.