From ae06e49c1d42d7f0c89c393cbaabda0200abcc56 Mon Sep 17 00:00:00 2001 From: SrJuggernaut Date: Tue, 14 Apr 2026 16:55:36 -0600 Subject: [PATCH] docs: add comprehensive README with installation and usage guide --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/README.md b/README.md index 71396e6..de4d5ae 100644 --- a/README.md +++ b/README.md @@ -1 +1,46 @@ # srjuggernaut-panda-preset + +A preset for [Panda CSS](https://panda-css.com) + +## Usage + +1. Install [Panda CSS](https://panda-css.com/docs/overview/getting-started) + +2. Set up the `@srjuggernaut-dev` registry + +with node add the following to your `.npmrc` + +``` +@srjuggernaut-dev:registry=https://git.srjuggernaut.dev/api/packages/SrJuggernaut/npm/ +``` +with bun add the following to your `bunfig.toml` + +``` +[install.scopes] +"@srjuggernaut-dev" = "https://git.srjuggernaut.dev/api/packages/SrJuggernaut/npm/" +``` + + + +3. Install the preset + +with node: +``` +npm install @srjuggernaut-dev/panda-preset +``` + +with bun: +``` +bun add @srjuggernaut-dev/panda-preset +``` + +4. [Add the preset](https://panda-css.com/docs/docs/customization/presets) to your `panda.config.{js,ts}` + +```javascript +import { defineConfig } from '@pandacss/dev' +import srJuggernautPandaPreset from '@srjuggernaut-dev/panda-preset' + +export default defineConfig({ + presets: [srJuggernautPandaPreset()], +}) +``` \ No newline at end of file