css-utils/README.md
ztimson 103be5f0d8
All checks were successful
Publish Library / Build NPM Project (push) Successful in 11s
Publish Library / Publish CDN & Docs (push) Successful in 17s
Publish Library / Tag Version (push) Successful in 5s
Bump 1.0.3
2024-11-17 23:55:01 -05:00

93 lines
2.9 KiB
Markdown

<!-- Header -->
<div id="top" align="center">
<br />
<!-- Logo -->
<img src="https://git.zakscode.com/repo-avatars/76cb13e0e27818654d364227400292abc6a4e6def657bd9f5713f4286e34e544" alt="Logo" width="200" height="200">
<!-- Title -->
### CSS Utils
<!-- Description -->
CSS Utility Classes
<!-- Repo badges -->
[![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/css-utils/tags&query=$[0].name)](https://git.zakscode.com/ztimson/css-utils/tags)
[![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/css-utils&query=open_pr_counter)](https://git.zakscode.com/ztimson/css-utils/pulls)
[![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/css-utils&query=open_issues_count)](https://git.zakscode.com/ztimson/css-utils/issues)
<!-- Links -->
---
<div>
<a href="https://css.zakscode.com" target="_blank">Documentation</a>
<a href="https://git.zakscode.com/ztimson/css-utils/releases" target="_blank">Release Notes</a>
<a href="https://git.zakscode.com/ztimson/css-utils/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
<a href="https://git.zakscode.com/ztimson/css-utils/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
</div>
---
</div>
## Table of Contents
- [Template](#top)
- [About](#about)
- [Built With](#built-with)
- [Setup](#setup)
- [Production](#production)
- [Development](#development)
- [Documentation](https://css.zakscode.com)
- [License](#license)
## About
This is a CSS utility library based on Bootstrap.
It includes all the utility libraries without any of the bloat.
Some extra classes have been added and a few class name changed to match convention.
### Built With
[![CSS](https://img.shields.io/badge/CSS-1572B6?style=for-the-badge&logo=css3)](https://www.w3.org/Style/CSS/Overview.en.html)
[![SASS](https://img.shields.io/badge/SASS-CC6699?style=for-the-badge&logo=sass&logoColor=ffffff)](https://sass-lang.com/)
## Setup
<details>
<summary>
<h3 id="production" style="display: inline">
Production
</h3>
</summary>
#### Prerequisites
- [NPM](https://docs.docker.com/install/)
#### Instructions
1. Install: `npm i @ztimson/css-utils`;
</details>
<details>
<summary>
<h3 id="development" style="display: inline">
Development
</h3>
</summary>
#### Prerequisites
- [Node.js](https://nodejs.org/en/download)
#### Instructions
1. Install the dependencies: `npm install`
2. Start the Angular server: `npm run build`
</details>
## Documentation
https://css.zaskscode.com
## License
Copyright © 2023 Zakary Timson | Available under MIT Licensing
See the [license](./LICENSE) for more information.