node-utils/README.md

92 lines
2.8 KiB
Markdown
Raw Permalink Normal View History

2024-11-29 17:57:07 -05:00
<!-- Header -->
<div id="top" align="center">
<br />
<!-- Logo -->
2024-11-29 17:58:59 -05:00
<img src="https://git.zakscode.com/repo-avatars/896dde302026e918e87e40f1059c1169c30d6844feb08e509ed2265eb8a9c90b" alt="Logo" width="200" height="200">
2024-11-29 17:57:07 -05:00
<!-- Title -->
### @ztimson/node-utils
<!-- Description -->
Node Utilities
<!-- 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/node-utils/tags&query=$[0].name)](https://git.zakscode.com/ztimson/node-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/node-utils&query=open_pr_counter)](https://git.zakscode.com/ztimson/node-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/node-utils&query=open_issues_count)](https://git.zakscode.com/ztimson/node-utils/issues)
<!-- Links -->
---
<div>
<a href="https://node-utils.docs.zakscode.com" target="_blank">Documentation</a>
<a href="https://git.zakscode.com/ztimson/node-utils/releases" target="_blank">Release Notes</a>
<a href="https://git.zakscode.com/ztimson/node-utils/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
<a href="https://git.zakscode.com/ztimson/node-utils/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
</div>
---
</div>
## Table of Contents
- [@ztimson/utils](#top)
- [About](#about)
- [Built With](#built-with)
- [Setup](#setup)
- [Production](#production)
- [Development](#development)
- [Documentation](https://node-utils.docs.zakscode.com/)
- [License](#license)
## About
A collection of node utilities to make life a little easier
### Built With
[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/)
## Setup
<details>
<summary>
<h3 id="production" style="display: inline">
Production
</h3>
</summary>
#### Prerequisites
- [Node.js](https://nodejs.org/en/download)
#### Instructions
1. Install persist: `npm i @ztimosn/node-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 i`
2. Build library: `npm build`
3. Run unit tests: `npm test`
</details>
## Documentation
[Available Here](https://node-utils.docs.zakscode.com/)
## License
Copyright © 2023 Zakary Timson | Available under MIT Licensing
See the [license](_media/LICENSE) for more information.