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.

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

Release v3.1.0 #1070

Merged
merged 1 commit into from
Oct 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ You can test this package using the embedded storybook. Please follow these step
To implement the MinIO Design System in your application, you can follow these steps:

1. Install the package by running `yarn add http://github.com/minio/mds#[Version]`. Replace `[Version]` with the version you want to install.
2. Import the required Geist & Geist Mono fonts in your application using your preferred method, Font Variants described as follows:
2. Import the required Geist & Geist Mono fonts in your application using your preferred method, Font Variants described as follows:

```css
{
Expand Down Expand Up @@ -101,6 +101,7 @@ To implement the MinIO Design System in your application, you can follow these s
},

```

3. Create an `mds.d.ts` file in the root of your project and add the following code and import it into your tsconfig.json file:

```typescript
Expand All @@ -112,13 +113,12 @@ declare module "@emotion/react" {
export type Theme = ThemeDefinition;
}
```

This is required to have the correct types for the theme object in your application.

4. Import the required components in your application. For example, to import the Button component, you can use `import { Button } from 'mds'`.
5. Use the imported component in your application.



## Build distribution files

To create distribution files you can run `yarn build` or `make build` in source folder. This will create the required dist folders.
Expand Down
Binary file removed dist/esm/assets/Geist-Black~qOvFQTkp.woff2
Binary file not shown.
Binary file removed dist/esm/assets/Geist-Bold~bIXqnewY.woff2
Binary file not shown.
Binary file removed dist/esm/assets/Geist-Light~mFrpOtUv.woff2
Binary file not shown.
Binary file removed dist/esm/assets/Geist-Medium~xvSHtfJJ.woff2
Binary file not shown.
Binary file removed dist/esm/assets/Geist-Regular~HBCtwmaC.woff2
Binary file not shown.
Binary file removed dist/esm/assets/Geist-SemiBold~HKwOtANj.woff2
Binary file not shown.
Binary file removed dist/esm/assets/Geist-Thin~zsMWvBSS.woff2
Binary file not shown.
Binary file removed dist/esm/assets/Geist-UltraLight~mJMijQEE.woff2
Binary file not shown.
Binary file removed dist/esm/assets/GeistMono-Regular~WhMCLXIx.woff2
Binary file not shown.
Loading
Loading