@quidgest/ui 0.0.7

package/README.md

@@ -0,0 +1,66 @@
+# Quidgest UI
+
+Quidgest Vue 3 component framework.
+
+## Features
+
+-   A collection of customizable and reusable Vue 3 components.
+-   Written in TypeScript for type safety and better developer experience.
+-   Easily style components using SCSS.
+-   Documentation and examples.
+
+## Install
+
+```cli
+pnpm add @quidgest/ui
+```
+
+## Usage
+
+Once installed, you can import and use components as follows:
+
+```vue
+<template>
+	<div>
+		<q-button>Click me</q-button>
+	</div>
+</template>
+
+<script>
+	import { QButton } from '@quidgest/ui'
+
+	export default {
+		components: {
+			QButton
+		}
+	}
+</script>
+```
+
+## Development
+
+The package utilizes Storybook for component development and organization. You can view the components locally in the Storybook documentation explorer.
+
+First, navigate to the package's directory:
+
+```cli
+cd ui
+```
+
+Next, run Storybook:
+
+```cli
+npm run storybook
+```
+
+(You might need to execute `pnpm install` beforehand if you haven't done so.)
+
+By default, Storybook will be running at `http://localhost:6006/`.
+
+## Running Unit Tests
+
+It's important to run unit tests during development to ensure code quality and correctness. Execute the following command to run the unit tests:
+
+```cli
+npm run test
+```