Here's a template for your GitHub README.md file:
CozyUtils is a utility package designed to streamline the tedious and repetitive tasks I find myself doing on almost every project.
Before setting up the project, ensure you have the following installed:
- Bun (Version 1.0.29 or later. Visit Bun.sh for installation instructions)
- Clone the repo
- Run "bun install"
- Run "bun run build"
- Copy the contents of the bin directory to (honestly idk, I've just exported mine to path)
CozyUtils provides a command-line interface with the following commands:
-svg2tsx <directory>
: Convert SVG files in a directory to React components.-img2export <directory> <output_file>
: Export Image files in a directory as named exports.
./cozyutils -svgtotsx ./icons
CozyUtils provides some convenient npm scripts:
dev
: Run the package in development mode.build
: Build the package for production.build:js
: Build the package with a specific target.