diff --git a/README.md b/README.md index 3c477d30..a8e9cdee 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,10 @@ - - - -
+ + + +@@ -18,6 +18,8 @@ A component's library helping us build great products for our customers. +[Storybook (live demo)](https://qvant-lab.github.io/qui-max/) + What is it? - 🔩 30+ Vue 3 components diff --git a/stories/intro.stories.mdx b/stories/intro.stories.mdx new file mode 100644 index 00000000..4892eb06 --- /dev/null +++ b/stories/intro.stories.mdx @@ -0,0 +1,163 @@ +import { Meta, Story } from '@storybook/addon-docs/blocks'; + + + +
+ +# Qui Max is a Vue 3 Design System for Web + +A component's library helping us build great products for our customers. + +What is it? + +- 🔩 30+ Vue 3 components +- 🔥 Fully written with Composition API +- 🔑 Typescript +- 📦 icons pack +- 🏳️🌈 colors & grid +- 🥷 neumorphism styles +- 📚 storybook sandbox + +Some examples below: + +![buttons](https://github.com/Qvant-lab/qui/raw/master/.readme-assets/buttons.jpg) +![inputs](https://github.com/Qvant-lab/qui/raw/master/.readme-assets/inputs.gif) +![icons](https://github.com/Qvant-lab/qui/raw/master/.readme-assets/icons.gif) +![tables](https://github.com/Qvant-lab/qui/raw/master/.readme-assets/tables.jpg) +![other](https://github.com/Qvant-lab/qui/raw/master/.readme-assets/other.jpg) + +## Install + +```bash +npm install @qvant/qui-max -S +yarn add @qvant/qui-max +``` + +You can import Qui entirely, or just import what you need. Let's start with fully import. + +## Quick setup + +In main.js: + +```js +import { createApp } from 'vue'; +import Qui from '@qvant/qui-max'; +import '@qvant/qui-max/styles'; + +const app = createApp(App); +// Setup all components +app.use(Qui, { useAllComponents: true }); +// that's it! All components will be imported with styles +``` + +in YourComponent.vue: (Example) + +```vue + +