Skip to content

Commit 6e5894b

Browse files
committed
feat: update docs & readme with links
1 parent 0d55bd0 commit 6e5894b

File tree

4 files changed

+53
-9
lines changed

4 files changed

+53
-9
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 aghontpi
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,24 @@
11
# Minimal CSS Utility
22

3-
A SCSS utility library for building modern websites.
3+
<p align="center">
4+
<a href="https://github.com/aghontpi/minimal-css-utility/releases"><img src="https://img.shields.io/github/v/release/aghontpi/minimal-css-utility?include_prereleases&style=flat-square&label=github-release" alt="release"></a>
5+
<a href="https://www.npmjs.com/package/minimal-css-utility"><img src="https://img.shields.io/npm/v/minimal-css-utility?style=flat-square" alt="npm"></a>
6+
<a href="https://github.com/aghontpi/minimal-css-utility/blob/main/LICENSE"><img src="https://img.shields.io/github/license/aghontpi/minimal-css-utility?style=flat-square" alt="license"></a>
7+
</p>
8+
9+
A lightweight CSS utility library to ease development.
410

511

612
## Documentation
7-
you can view it from, the full documentation for the utility classes can be found in the `docs/` directory of this repository.
13+
You can view the documentation at [minimal-css-utility](https://bluepie.in/minimal-css-utility/). The full documentation for the utility classes can also be found in the `docs/` directory of this repository.
814

915

1016
## Motivation
1117

12-
For my projects, I use reset.css and a set of utility classes without external libraries, I copy and paste them from project to project. This eliminates it and makes it easier to maintain and see the docs easily as well.
18+
I wanted a minimal CSS utility that provides just basic features to get started quickly without the bloat of larger frameworks.
19+
20+
21+
For my projects, I use reset.css and a set of utility classes without external libraries, I move them from project to project. This eliminates it and makes it easier to maintain and view the docs.
1322

1423
## Features
1524

@@ -22,14 +31,13 @@ For my projects, I use reset.css and a set of utility classes without external l
2231
- Spacing
2332
- Typography
2433

25-
26-
27-
2834
## Installation
2935

3036
Install the package from npm:
3137

3238
```bash
39+
# using npm
40+
3341
npm install minimal-css-utility
3442

3543
# or using yarn
@@ -40,6 +48,16 @@ yarn add minimal-css-utility
4048
pnpm add minimal-css-utility
4149
```
4250

51+
## CDN
52+
53+
You can also use the compiled CSS file from a CDN:
54+
55+
```html
56+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/minimal-css-utility/dist/min.css">
57+
```
58+
59+
Link: https://cdn.jsdelivr.net/npm/minimal-css-utility/dist/min.css
60+
4361
## Usage
4462

4563
You can either import the compiled CSS file into your project or import the SCSS files.
@@ -83,3 +101,8 @@ If you want to build the CSS from the source SCSS files, you can do so by follow
83101
```
84102

85103
This will generate the `dist/min.css` file.
104+
105+
## License
106+
107+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
108+

docs/getting-started/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ To use this utility in your project, you can either link to the compiled CSS fil
2121
### Linking the CSS
2222

2323
```html
24-
<link rel="stylesheet" href="minimal-css-utility/dist/min.css">
24+
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/minimal-css-utility/dist/min.css">
2525
```
2626

2727
### Importing the SCSS

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
"utility",
1919
"css"
2020
],
21-
"author": "",
22-
"license": "ISC",
21+
"author": "aghontpi",
22+
"license": "MIT",
2323
"packageManager": "pnpm@10.20.0",
2424
"devDependencies": {
2525
"postcss": "^8.5.6",

0 commit comments

Comments
 (0)