tiny-essentials
Version:
Collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility.
112 lines (74 loc) โข 5.46 kB
Markdown
<div align="center">
<img src="./test/img/banner/tiny-essentials.jpg" alt="banner" />
<p>
<a href="https://discord.gg/TgHdvJd"><img src="https://img.shields.io/discord/413193536188579841?color=7289da&logo=discord&logoColor=white" alt="Discord server" /></a>
<a href="https://www.npmjs.com/package/tiny-essentials"><img src="https://img.shields.io/npm/v/tiny-essentials.svg?maxAge=3600" alt="NPM version" /></a>
<a href="https://www.npmjs.com/package/tiny-essentials"><img src="https://img.shields.io/npm/dt/tiny-essentials.svg?maxAge=3600" alt="NPM downloads" /></a>
</p>
<p>
<a href="https://www.patreon.com/JasminDreasond"><img src="https://img.shields.io/badge/donate-patreon-F96854.svg?logo=patreon" alt="Patreon" /></a>
<a href="https://ko-fi.com/jasmindreasond"><img src="https://img.shields.io/badge/donate-ko%20fi-29ABE0.svg?logo=ko-fi" alt="Ko-Fi" /></a>
<a href="https://chain.so/address/BTC/bc1qnk7upe44xrsll2tjhy5msg32zpnqxvyysyje2g"><img src="https://img.shields.io/badge/donate-bitcoin-F7931A.svg?logo=bitcoin" alt="Bitcoin" /></a>
<a href="https://chain.so/address/LTC/ltc1qchk520v4u8334n5dntmgeja55gc5g5rrkgpd4f"><img src="https://img.shields.io/badge/donate-litecoin-345D9D.svg?logo=litecoin" alt="Litecoin" /></a>
<a href="https://commerce.coinbase.com/checkout/817de5cb-d88e-4d79-8af3-a4b8696f2f2a"><img src="https://img.shields.io/badge/donate-coinbase-3B99FC.svg" alt="Litecoin" /></a>
</p>
<p>
<a href="https://nodei.co/npm/tiny-essentials/"><img src="https://nodei.co/npm/tiny-essentials.png?downloads=true&stars=true" alt="npm installnfo" /></a>
</p>
</div>
# ๐งฉ Tiny Essentials
**Tiny Essentials** is a collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility.
## โจ Features
Tiny Essentials provides a wide range of utilities โ from array manipulations and time calculations to object helpers and custom tools.
For the **full list of features and usage examples**, please check the [documentation](./docs).
## ๐ฆ Installation
You can install Tiny Essentials via npm:
```bash
npm install tiny-essentials
```
Or download the scripts directly from this repository.
## ๐งช Module Versions
The core version of Tiny Essentials (version 1) is located in the folder [`/src/v1`](./src/v1).
A detailed README is available inside the [`v1`](./src/v1) folder, which contains a full description of all utility modules and their functionalities.
We recommend checking it out if you want to see all available tools in this version and how to use them individually or collectively via the `index.mjs` global module.
## ๐ Documentation
Looking for detailed module explanations and usage examples?
Check out the full documentation here:
๐ [Go to docs page](./docs/v1/README.md)
---
## ๐ฆ More Tiny Essentials Modules
- ๐ค [**tiny-ai-api**](https://github.com/JasminDreasond/Tiny-AI-API) โ Minimal AI API wrapper.
- ๐ฒ [**tiny-dices**](https://github.com/JasminDreasond/Tiny-Dices) โ Simple dice and randomness utilities.
- ๐ [**tiny-crypto-suite**](https://github.com/JasminDreasond/Tiny-Crypto-Suite) โ Lightweight cryptography toolkit.
- ๐ฅ๏ธ [**tiny-server-essentials**](https://github.com/JasminDreasond/Tiny-Server-Essentials) โ Node.js server utilities.
- ๐ช [**tiny-electron-essentials**](https://github.com/JasminDreasond/Tiny-Electron-Essentials) โ Essential tools for Electron apps.
- ๐๏ธ [**puddysql**](https://github.com/JasminDreasond/PuddySQL) โ Smart SQL engine for structured data, tags, and advanced queries.
---
### ๐ง Recommended Tool: **JsStore**
Although not part of Tiny Essentials, we recommend using [**JsStore**](https://www.npmjs.com/package/jsstore) if you're looking for a well-maintained and developer-friendly solution to interact with **IndexedDB** using SQL-like syntax.
> ๐ฌ *This is a personal recommendation. This project is not sponsored or affiliated with JsStore.*
---
## ๐๏ธ Legacy Code
The scripts previously maintained in this repository have been migrated to the following location:
๐ https://github.com/JasminDreasond/Tiny-Essentials-Legacy
This includes modules such as:
- `/firebase-lib`
- `/discord-oauth2`
- `/mysql-connector`
- `/puddy-lib`
These modules are preserved for backwards compatibility and may not receive further active development.
---
## ๐ค Contributions
Feel free to fork, contribute, and create pull requests for improvements! Whether it's a bug fix or an additional feature, contributions are always welcome.
## ๐ License
This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details.
### ๐ก Credits
This project was inspired by the need for lightweight, reusable code that can be used across many different kinds of applications. Contributions and suggestions are always appreciated!
> ๐ง **Note**: This documentation was written by [ChatGPT](https://openai.com/chatgpt), an AI assistant developed by OpenAI, based on the project structure and descriptions provided by the repository author.
> If you find any inaccuracies or need improvements, feel free to contribute or open an issue!
---
<div align="center">
<a href="./test/img/"><img src="./test/img/5ec92aff-7a9d-4b86-bcc3-fe715def537a.png" height="300" /></a>
<br/>
Made with tiny love!
</div>