Skip to content

Commit

Permalink
[DST-107]: Update-readme (#3245)
Browse files Browse the repository at this point in the history
  • Loading branch information
OsamaAbdellateef authored Aug 1, 2023
1 parent 5aaaba6 commit 2dff89d
Show file tree
Hide file tree
Showing 2 changed files with 429 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img width="494" align="center" alt="type_logo" src="https://user-images.githubusercontent.com/59875255/75779675-530ca980-5d5a-11ea-8910-7e92ded472e3.png">
<img width="494" align="center" alt="type_logo" src="https://raw.githubusercontent.com/marigold-ui/marigold/45a5ac5c3ef740a5698958f2a3244743ef9b3338/Marigold-Logo.svg">
</p>
<br>
<br>
Expand All @@ -10,7 +10,7 @@

# Marigold

React implementation of the Marigold Design System based on [Emotion](https://emotion.sh/) and [theme-ui](https://theme-ui.com/).
React implementation of the Marigold Design System based on [react-aria](https://react-spectrum.adobe.com/react-aria/) and [Tailwind CSS](https://tailwindcss.com/).

## Installation 🔧

Expand All @@ -31,10 +31,10 @@ If you want to use a marigold theme you have to install them seperatly like:

```sh
# with npm
npm install @marigold/theme-unicorn --save
npm install @marigold/theme-b2b --save

# with yarn
yarn add @marigold/theme-unicorn
yarn add @marigold/theme-b2b
```

## Usage 💡
Expand All @@ -45,9 +45,9 @@ Use the styles for your component from a global `theme` object. To provide the t
// basic usage
import React from 'react'
import { MarigoldProvider, Text } from '@marigold/components'
import unicornTheme from '@marigold/theme-unicorn'
import b2bTheme from '@marigold/theme-b2b'
<MarigoldProvider theme={unicornTheme}>
<MarigoldProvider theme={b2bTheme}>
<Text>Lorem ipsum</Text>
</MarigoldProvider>
```
Expand Down
Loading

2 comments on commit 2dff89d

@vercel
Copy link

@vercel vercel bot commented on 2dff89d Aug 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

marigold-docs – ./

marigold-docs-marigold.vercel.app
marigold-docs-git-main-marigold.vercel.app
marigold-docs.vercel.app

@vercel
Copy link

@vercel vercel bot commented on 2dff89d Aug 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

marigold-storybook – ./

marigold-latest.vercel.app
marigold-storybook-git-main-marigold.vercel.app
marigold-storybook-marigold.vercel.app

Please sign in to comment.