Add README in directory

packages/mockline/README.md

@@ -0,0 +1,122 @@
+![Mockline Social Preview](assets/social-preview.jpg)
+
+<p align="center">
+  <a aria-label="NPM version" href="https://www.npmjs.com/package/mockline">
+    <img alt="" src="https://img.shields.io/npm/v/mockline.svg?style=for-the-badge&labelColor=000000&color=E0E0E0">
+  </a>
+  <a aria-label="License" href="https://github.com/mockline/mockline/main/LICENSE">
+    <img alt="" src="https://img.shields.io/npm/l/mockline.svg?style=for-the-badge&labelColor=000000&color=212121">
+    </a>
+  <a aria-label="Join the community on Discord" href="https://discord.gg/BkgyMzvJ3p">
+    <img alt="" src="https://img.shields.io/badge/Join%20the%20community-F74804.svg?style=for-the-badge&logo=Discord&labelColor=000000&logoWidth=20&logoColor=white">
+  </a>
+  <a aria-label="Mockline logo" href="https://mockline.dev/">
+    <img src="https://img.shields.io/badge/MADE%20WITH%20Mockline-000000.svg?style=for-the-badge&logo=Mockline&labelColor=000000&logoWidth=20&logoColor=white">
+  </a>
+  <a aria-label="Follow Hugo on Twitter" href="https://twitter.com/HugoRCD__">
+    <img alt="" src="https://img.shields.io/twitter/follow/HugoRCD__.svg?style=for-the-badge&labelColor=000000&logo=twitter&label=Follow%20Hugo&logoWidth=20&logoColor=white">
+  </a>
+</p>
+
+Welcome to Mockline, your go-to design library crafted to elevate your creative journey. Whether you're a seasoned designer or a budding developer, Mockline is designed to empower you with efficient, innovative, and collaborative tools, putting the joy back into the design process.
+
+
+## Getting Started
+
+Visit [mockline.dev](https://mockline.dev) to get started with Mockline.
+
+## Features
+
+- **Fully customizable**: All components are customizable via props and slots.
+- **Dark mode**: Enjoy a seamless dark mode experience.
+- **Responsive**: Components are designed to be responsive across all devices.
+- **Easy to use**: Mockline is designed to be beginner-friendly, with a simple setup process.
+- **Community-driven**: Join the Mockline community on Discord to connect with other users and share your feedback.
+- **Open-source**: Mockline is open-source, and we welcome contributions from the community.
+
+## Quick Setup
+
+For the moment Mockline is only available for Nuxt projects (Vue 3 support and react support will be added soon).
+To get started, follow these steps:
+
+
+1. Add `mockline` dependency to your project
+
+```bash
+# Using bun
+bun install -D mockline
+
+# Using pnpm
+pnpm add -D mockline
+
+# Using yarn
+yarn add --dev mockline
+
+# Using npm
+npm install --save-dev mockline
+```
+
+2. Add `mockline` to the `modules` section of `nuxt.config.ts`
+
+```js
+export default defineNuxtConfig({
+  modules: [
+    'mockline'
+  ]
+})
+```
+
+That's it! You can now use Mockline in your Nuxt app ✨
+## Community
+
+The Mockline community can be found on Discord, to chat with other community members, you can join the [Mockline Discord](https://discord.gg/BkgyMzvJ3p).
+
+<!-- automd:fetch url="gh:hugorcd/markdown/main/src/contributions.md" -->
+
+## Contributing
+To start contributing, you can follow these steps:
+
+1. First raise an issue to discuss the changes you would like to make.
+2. Fork the repository.
+3. Create a branch using conventional commits and the issue number as the branch name. For example, `feat/123` or `fix/456`.
+4. Make changes following the local development steps.
+5. Commit your changes following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
+6. If your changes affect the code, run tests using `bun run test`.
+7. Create a pull request following the [Pull Request Template](https://github.com/HugoRCD/markdown/blob/main/src/pull_request_template.md).
+   - To be merged, the pull request must pass the tests/workflow and have at least one approval.
+   - If your changes affect the documentation, make sure to update it.
+   - If your changes affect the code, make sure to update the tests.
+8. Wait for the maintainers to review your pull request.
+9. Once approved, the pull request will be merged in the next release !
+
+<!-- /automd -->
+
+<!-- automd:fetch url="gh:hugorcd/markdown/main/src/local_development.md" -->
+
+### Local development
+
+- Clone this repository
+- Install latest LTS version of [Node.js](https://nodejs.org/en/)
+- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
+- Install dependencies using `bun install`
+
+<!-- /automd -->
+
+<!-- automd:contributors license=Apache author=HugoRCD -->
+
+Published under the [APACHE](https://github.com/mockline/mockline/blob/main/LICENSE) license.
+Made by [@HugoRCD](https://github.com/HugoRCD) and [community](https://github.com/mockline/mockline/graphs/contributors) 💛
+<br><br>
+<a href="https://github.com/mockline/mockline/graphs/contributors">
+<img src="https://contrib.rocks/image?repo=mockline/mockline" />
+</a>
+
+<!-- /automd -->
+
+<!-- automd:with-automd lastUpdate -->
+
+---
+
+_🤖 auto updated with [automd](https://automd.unjs.io) (last updated: Wed May 22 2024)_
+
+<!-- /automd -->