diff --git a/README.md b/README.md index 9045c0d..b37888d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,18 @@ -# smarphy +# smarpy -smartupcorp web design +[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/smartupcorp/smarpy/blob/main/LICENSE) +[![NPM Version](https://img.shields.io/npm/v/@smartupcorp/smarpy)](https://www.npmjs.com/package/@smartupcorp/smarpy) +[![npm downloads](https://img.shields.io/npm/dm/@smartupcorp/smarpy)](https://www.npmjs.com/package/@smartupcorp/smarpy) + +[![NPM](https://nodei.co/npm/@smartupcorp/smarpy.png)](https://nodei.co/npm/@smartupcorp/smarpy/) + +## Overview + +smarpy is an open-source web design sass library. + +It uses `oklch()` to declare color palette. + +If you want to use in React Project, you can use [react-smarpy](https://github.com/smartupcorp/react-smarpy). ## Installation @@ -9,3 +21,25 @@ smartupcorp web design ```node npm install @smartupcorp/smarpy ``` + +### Use in CSS + +#### From CDN + +```html + +``` + +```html + +``` diff --git a/docs/index.html b/docs/index.html index b418ab9..581da4a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1331,7 +1331,7 @@