svcorelib/README.md

Core library used in the projects of Sv443 and the Sv443 Network. Contains tons of miscellaneous QoL features.

<div align="center" style="text-align:center;">

![logo](https://sv443.net/resources/images/svcorelib_small.png)

# SvCoreLib
[![MIT License](https://img.shields.io/npm/l/svcorelib)](https://sv443.net/LICENSE) [![GitHub issues](https://img.shields.io/github/issues/Sv443-Network/SvCoreLib)](https://github.com/Sv443-Network/SvCoreLib/issues) [![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/svcorelib)](https://snyk.io/)

<br>

### Core Library used in the projects of Sv443 and the Sv443 Network,<br>containing tons of miscellaneous quality of life features
Contains builtin TypeScript definitions

<br>

## >> [Documentation](https://github.com/Sv443-Network/SvCoreLib/blob/master/docs.md#readme) <<
#### [Discord](https://dc.sv443.net) • [Changelog](https://github.com/Sv443-Network/SvCoreLib/blob/master/changelog.md#readme)

</div>

<br>

## Most notable features:
- Interactive CLI tools like a menu and a progress bar
- Networking tools like downloading files and pinging URLs or efficiently serving data to a connecting client
- File system tools like reading a directory recursively, downloading a file or supervising a directory for changes
- Randomization tools like generating UUIDs or a seeded RNG
- Misc tools involving array manipulation
  
See a list of all features [here.](./docs.md#table-of-contents)

<br>

## Install:
Use this command in a terminal window inside your Node.js project:
```
npm i svcorelib
```

If you don't intend on using SQL functions, use `npm i svcorelib --no-optional`

<br>

## Contributors:
Thank you very much to these contributors for improving SvCoreLib ❤️
| Name | Contributions |
| --- | --- |
| [canarado](https://github.com/canarado) | Added TypeScript declarations, fixed grammar |
| [ThatCopy](https://github.com/ThatCopy) | Fixed documentation, tested the code |

<br>

## Dependencies:
I made SvCoreLib so it needs as few dependencies as possible, but in order to ensure quality and stability, these dependencies are needed:
- [deep-diff](https://npmjs.com/package/deep-diff)
- [fs-extra](https://npmjs.com/package/fs-extra)
- [keypress](https://npmjs.com/package/keypress)
- [minimatch](https://npmjs.com/package/minimatch)
- [mysql](https://npmjs.com/package/mysql) *

\*<sup> = optional, see [installation](#install)</sup>

<br><br><br>

<div align="center" style="text-align:center">

Made with ❤️ by [Sv443](https://github.com/Sv443) and [others](https://github.com/Sv443-Network/SvCoreLib/graphs/contributors)  
Like SvCoreLib? Please consider [supporting our development](https://github.com/sponsors/Sv443)

</div>