Created the package

README.md

@@ -1,42 +1,32 @@
-# Open-source stack
-
-Full starter stack to develop CJS/ESM compatible packages with TypeScript, Vitest, ESLint, Prettier, and GitHub Actions.
-
-## Tools
-
-- **TypeScript**: TypeScript is a typed superset of JavaScript that compiles to plain JavaScript.
-- **Vitest**: A modern test runner built on top of Vite.
-- **ESLint**: ESLint statically analyzes your code to quickly find problems.
-- **Prettier**: Prettier is an opinionated code formatter.
-- **GitHub Actions**: Automate your workflow from idea to production.
-- **tsup** - Zero-config bundler for tiny TypeScript libraries.
-
-## Features
-
-- **ESM/CJS ready** - Write your code in TypeScript and publish it as ESM and CJS with 0 configuration.
-- **Are The types wrong? ready** - Passes all the checks for typings on https://arethetypeswrong.github.io/ by default.
-- **ESM/CJS test apps setup** - Test your package in both ESM and CJS environments already setup for you.
-- **Test runner setup** - Test your open source package with Vitest already setup for you.
-- **Linting setup** - Lint your code with ESLint and Prettier already setup for you.
-- **GitHub Actions setup** - Automate deployments to npm by using GitHub Actions.
-
-## Setup
-
-1. Use this template to create a new repository.
-2. Clone the repository.
-3. Install the dependencies with `npm install`.
-4. Change the package name in `package.json`.
-5. Change the `repository`, `bugs`, and `homepage` fields in `package.json` to your github repo.
-6. Change the license if required.
-7. Change the `open-source-stack` dependency in your test-apps to your name
-8. Add the NPM_TOKEN secret to your GitHub repository.
-9. Start coding!
-
-## Scripts
-
-- `npm run build` - Build the package.
-- `npm run test` - Run the tests.
-- `npm run lint` - Lint the code.
-- `npm run dev` - Start the package and ESM test app in watch mode for development.
-- `npm run dev:cjs` - Start the package and CJS test app in watch mode for development.
-
+# vite-plugin-icons-spritesheet
+A Vite plugin to generate a spritesheet with icons from a directory, re-runs on every edit/delete/add to the directory that is being watched.
+
+Optionally generates TypeScript types for the icon names that it outputs.
+
+## Installation
+```bash
+npm install -D vite-plugin-icons-spritesheet
+```
+
+## Usage
+```javascript
+// vite.config.js
+import { iconSpritesheet } from 'vite-plugin-icons-spritesheet';
+
+export default {
+  plugins: [
+     iconSpritesheet({
+      // Defaults to false, should it generate TS types for you
+      withTypes: true,
+      // The path to the icon directory
+      inputDir: "icons",
+      // Output path for the generated spritesheet and types
+      outputDir: "public/icons",
+      // The name of the generated spritesheet, defaults to sprite.svg
+      fileName: "icon.svg",
+      // The cwd, defaults to process.cwd()
+      cwd: process.cwd(),
+    }),
+  ],
+};
+```