@reliverse/addons: [Package Name]

@reliverse/acme is a @reliverse/addons template that provides a starting point for developing new packages within the Reliverse ecosystem, offering pre-configured setup and guidelines to streamline the creation of consistent, high-quality packages.

[Package Description: Briefly describe what the package does and how it fits into the @reliverse/addons ecosystem.]

Note: [Additional Information: Include any specific notes or focuses for the package, such as whether it extends existing functionality or introduces new utilities.]

For detailed usage instructions, API documentation, and examples, please visit the Reliverse Docs website. If the page for this package is missing, please notify us or consider contributing to add it.

Installation

To install or update this package, run:

pnpm add @reliverse/[package-name]@latest

or with Bun:

bun add @reliverse/[package-name]@latest

How to Use This Library

To use @reliverse/[package-name], ensure that your project is set up as an ES module by including "type": "module" in your package.json file. Since this package is structured as an ES module, you'll need to use import statements instead of require.

Here's an example of how to import and use a function from this package:

import { [functionName] } from "@reliverse/[package-name]";

const someFile = "path/to/file";

export async function exampleFunction() {
  await [functionName](someFile);
}

Please refer to the source files located in the src folder to learn about the currently implemented functions.

This package adopts the ES module format, with files compiled to dist/.js. This aligns with the Node.js team's recent recommendations, encouraging the JavaScript/TypeScript community to transition to the ES module standard. If your project still requires CommonJS (CJS) support, you may fork this repository and modify the build process to generate dist/.cjs files. For guidance or community support, join the Reliverse Discord community.

Documentation and Support

If you encounter any issues, need help, or want to contribute, you can:

• Join the Reliverse Discord community to ask questions and engage with other users and developers.
• For usage instructions, API documentation, and examples, please visit the Reliverse Docs website.
• Report bugs or suggest features by opening an issue on our GitHub repository.

Sponsors

Love using this project? If you find it useful, I’d greatly appreciate a cup of coffee! By supporting this project, you'll gain access to Reliverse Pro, exclusive access to @reliverse/addons-pro, private repositories, pre-release downloads, and even the ability to influence project planning. Click on the donation platforms below to learn more. Thank you all for your support!

We're Growing Fast! A Huge Thanks to All Our Supporters!

Developing something as ambitious as @reliverse/addons takes a huge amount of time, especially since the project is primarily developed by one person. The development could be significantly accelerated by bringing on additional developers. Therefore, @blefnk (Nazar Kornienko), the author of this project, would be immensely grateful to anyone who can contribute financially in any amount. A big thank you in advance to everyone who supports this effort!

Visit the "Donate to Relivator" page to see our current donors and learn more.

💚 GitHub Sponsors 🩵 PayPal 🧡 Patreon 💛 Buy Me a Coffee 🩷 Ko-fi

Contributing

We welcome contributions! If you’d like to contribute to the development of this package, please follow these steps:

1. If you are a beginner: Familiarize yourself with Git by following The Detailed Git Guide created by @blefnk and @reliverse.
2. Fork this repository.
3. Create a new branch for your feature (e.g. git checkout -b feature-branch).
4. Make your changes in the new branch.
5. Commit your changes with a descriptive message (e.g. git commit -m 'Add new feature').
6. Push your changes to your branch (e.g. git push origin feature-branch).
7. Open a pull request for our review.

Please ensure that your code follows the existing code style and includes appropriate tests. Your code should successfully pass the pnpm appts command.

License

This project is developed by Reliverse and @blefnk (Nazar Kornienko) and is licensed under the MIT License. For more information, please refer to the LICENSE file.