minolith 0.0.18 → 0.0.19

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 mino.*
+Copyright (c) 2024 minominolyly
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1 +1,70 @@
-# minolith
+# minolith
+
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/minominolyly/minolith/blob/main/LICENSE)
+[![NPM Version](https://img.shields.io/npm/v/minolith)](https://www.npmjs.com/package/minolith)
+[![npm downloads](https://img.shields.io/npm/dm/minolith)](https://www.npmjs.com/package/minolith)
+
+## Overview
+
+minolith is an open-source sass library.
+
+It uses `oklch()` to declare color palette.
+
+If you want to use in React Project, you can use [react-minolith](https://github.com/minominolyly/react-minolith).
+
+## ⚠️Heed
+
+minolith is still alpha.
+
+## Installation
+
+### Use minolith Sass library
+
+#### Install the NPM package
+
+minolith is available through npm.
+
+```shell
+npm install minolith
+```
+
+### Use minolith CSS
+
+#### From CDN
+
+You can import the CSS file directly from unpkg.com
+
+```html
+<link
+  rel="stylesheet"
+  type="text/css"
+  media="all"
+  href="https://unpkg.com/minolith/dist/css/minolith.min.css"
+/>
+```
+
+If you need to use `utilities`, you can use `minolith-utilities.css`.
+
+```html
+<link
+  rel="stylesheet"
+  type="text/css"
+  media="all"
+  href="https://unpkg.com/minolith/dist/css/minolith.min.css"
+/>
+```
+
+If you don't need to use `color` and `utilities`, you can use `minolith-skelton.css`.
+
+```html
+<link
+  rel="stylesheet"
+  type="text/css"
+  media="all"
+  href="https://unpkg.com/minolith/dist/css/minolith-skelton.min.css"
+/>
+```
+
+## License
+
+This project is licensed under the terms of the [MIT license](https://github.com/minominolyly/minolith/blob/main/LICENSE).