docs: add comprehensive README with installation and usage guide

2026-04-14 16:55:36 -06:00
parent 74ad449625
commit ae06e49c1d
1 changed files with 45 additions and 0 deletions
@@ -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()],
+})
+```