Skip to content

Commit

Permalink
updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
paulosabayomi committed Dec 11, 2023
1 parent 869e414 commit a3468b5
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
3 changes: 3 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"recommendations": []
}
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,20 @@
[![PRs Welcome](https://img.shields.io/badge/PRs-Welcome-brightgreen.svg?style=flat-square)](https://github.com/paulosabayomi/CustUp/pulls)
[![Tests](https://github.com/paulosabayomi/CustUp/actions/workflows/node.js.yml/badge.svg)](https://github.com/paulosabayomi/CustUp/actions/workflows/node.js.yml)
<!-- [END BADGES] -->
![CustUp Init](https://github.com/paulosabayomi/CustUp/blob/master/_assets/custup-default.png)
CustUp is a highly customizable library with zero dependency, and can be easily adapted to a wide range of applications.

![CustUp Init](https://github.com/paulosabayomi/CustUp/blob/master/_assets/custup-default.png)

CustUp is a highly customizable library with zero dependency, and can be easily adapted to a wide range of applications.

## Quick Start

```js
import CustUp from 'path/to/custup/src/custup.min.js'
const instance1 = new CustUp({
targetRootElement: '#container',
})
```
This will load the default UI which you can further customize to fit your need or the need of your application

**More documentations in progress...**

This will load the default UI which you can further customize to fit your need or the need of your application

**More documentations in progress...**

0 comments on commit a3468b5

Please sign in to comment.