Skip to content

Commit

Permalink
fix: added license and readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
brimmann committed Jul 29, 2024
1 parent 2c1617f commit f9bf18a
Show file tree
Hide file tree
Showing 2 changed files with 108 additions and 1 deletion.
24 changes: 24 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
MIT License with Name Retention Clause

Copyright (c) 2024 Mohammad Rahid Stanikzai

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

**Name Retention Clause**: Any derivative works or modifications of this Software
must retain the original name of the Software as specified by the original author.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
85 changes: 84 additions & 1 deletion lib/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,84 @@
This vue component library will help save money and time.
# 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 `<div>` 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
<template>
<SketchyDiv class="pd" style="margin-bottom: 10px">INsied</SketchyDiv>
<SketchyBtn
label="Click"
style="padding: 10px 5px; font-size: 18px; margin-bottom: 100px"
/>
<SketchyHLine />
<div>NEXT</div>
<br />
<SketchyTabs v-model="tab">
<SketchyTab name="focuz" label="Focuz Time" />
<SketchyTab name="short" label="Short Break" />
<SketchyTab name="long" label="Long Break" />
</SketchyTabs>
</template>

<script setup>
import { SketchyDiv, SketchyBtn, SketchyHLine, SketchyTab, SketchyTabs } from "codeglynuikit";
import { ref } from "vue";

const tab = ref("focuz")

</script>

<style>
.pd {
padding: 80px;
}
</style>
```
## 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.

0 comments on commit f9bf18a

Please sign in to comment.