diff --git a/README.md b/README.md new file mode 100644 index 0000000..f61bd28 --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +# Vue Sketchy Components Library + +Welcome to the **Codeglyn UI Kit**! This library is designed to help you save time and money by providing simple yet powerful UI components that you can easily integrate into your projects. + +## Table of Contents + +- Introduction +- Components + - SketchyDiv + - SketchyBtn + - Tabs and Tab + - SketchyHLine +- Installation +- Usage +- Contributing +- License + +## Introduction + +The Vue Sketchy Components Library allows you to build and design your UI without worrying too much about the details. It's simple but powerful, making it easy to create beautiful interfaces quickly. + +## Components + +### SketchyDiv + +The `SketchyDiv` component is the most basic component in this library. It can be used anywhere just like normal `
` elements. + +### SketchyBtn + +The `SketchyBtn` component is a button that works just like normal buttons. It's easy to use and customize. + +### Tabs and Tab + +The `Tabs` component is the parent element, and the `Tab` component should be placed inside it. This allows you to create tabbed interfaces effortlessly. + +### SketchyHLine + +The `SketchyHLine` component is a simple horizontal line separator that you can use to divide sections of your UI. + +## Installation + +To install the Vue Sketchy Components Library, use npm or yarn: + +```bash +npm install codeglynuikit +``` + +## Usage +```javascript + + + + + +``` +## Contributing +We welcome contributions to the Vue Sketchy Components Library! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request on our GitHub repository or you can also contact me through my email. I would love to hear from me. + +## Licence +This project is licensed under the MIT License. See the LICENSE file for more details. diff --git a/lib/package.json b/lib/package.json index 4c2ec46..d517fa6 100644 --- a/lib/package.json +++ b/lib/package.json @@ -13,6 +13,33 @@ "require": "./dist/codeglynuikit.cjs" } }, + "repository": { + "type": "git", + "url": "git+https://github.com/quasarframework/sketchycodeglyn.git" + }, + "keywords": [ + "vuejs", + "vue", + "components", + "js", + "phone", + "tablet", + "desktop", + "spa", + "pwa", + "website", + "library" + ], + "author": { + "name": "Mohammad Rashid Stanikzai", + "email": "mohammadrashidstanikzai@gmail.com", + "url": "https://codeglyn.com" + }, + "license": "MIT", + "bugs": { + "url": "https://github.com/brimmann/sketchycodeglyn/issues" + }, + "homepage": "https://github.com/quasarframework/sketchycodeglyn", "scripts": { "dev": "vite", "build": "vite build",