css-utils/README.md

90 lines
2.9 KiB
Markdown
Raw Normal View History

2024-11-12 13:57:52 -05:00
<!-- Header -->
<div id="top" align="center">
<br />
<!-- Logo -->
2024-11-12 14:32:22 -05:00
<img src="https://git.zakscode.com/repo-avatars/76cb13e0e27818654d364227400292abc6a4e6def657bd9f5713f4286e34e544" alt="Logo" width="200" height="200">
2024-11-12 13:57:52 -05:00
<!-- Title -->
2024-11-12 14:32:22 -05:00
### CSS Utils
2024-11-12 13:57:52 -05:00
<!-- Description -->
2024-11-12 14:32:22 -05:00
CSS Utility Classes
2024-11-12 13:57:52 -05:00
<!-- Repo badges -->
2024-11-12 14:32:22 -05:00
[![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)
2024-11-12 13:57:52 -05:00
<!-- Links -->
---
<div>
2024-11-12 14:32:22 -05:00
<a href="https://git.zakscode.com/ztimson/css-utils/wiki" 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>
2024-11-12 13:57:52 -05:00
</div>
---
</div>
## Table of Contents
- [Template](#top)
- [About](#about)
- [Built With](#built-with)
- [Setup](#setup)
- [Production](#production)
- [Development](#development)
2024-11-12 14:32:22 -05:00
- [Documentation](#documentation)
2024-11-12 13:57:52 -05:00
- [License](#license)
## About
2024-11-12 14:32:22 -05:00
This is a CSS utility library based on Bootstrap.
2024-11-12 13:57:52 -05:00
2024-11-12 14:32:22 -05:00
It includes all the utility libraries without any of the bloat.
2024-11-12 13:57:52 -05:00
2024-11-12 14:32:22 -05:00
Some extra classes have been added and a few class name changed to match convention.
2024-11-12 13:57:52 -05:00
### 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
2024-11-12 14:32:22 -05:00
- [NPM](https://docs.docker.com/install/)
2024-11-12 13:57:52 -05:00
#### Instructions
2024-11-12 14:32:22 -05:00
1. Install: `npm i @ztimson/css-utils`;
2024-11-12 13:57:52 -05:00
</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`
2024-11-12 14:32:22 -05:00
2. Start the Angular server: `npm run build`
2024-11-12 13:57:52 -05:00
</details>
## License
2024-11-12 14:32:22 -05:00
Copyright © 2023 Zakary Timson | Available under MIT Licensing
2024-11-12 13:57:52 -05:00
See the [license](./LICENSE) for more information.