@scrymore/scry-deployer 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +64 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -5,7 +5,7 @@ Deploy your Storybook to the cloud with one command. ⚡
5
5
  ## 🎯 Quick Start (5 seconds)
6
6
 
7
7
  ### 1. Get your credentials
8
- Visit the [Scry Dashboard](https://dashboard.scry.com) and:
8
+ Visit the [Scry Dashboard](https://dashboard.scrymore.com) and:
9
9
  - 🔐 Login with your account (Firebase)
10
10
  - 📦 Create a new project
11
11
  - 📋 Copy your **Project ID** and **API Key**
@@ -13,7 +13,7 @@ Visit the [Scry Dashboard](https://dashboard.scry.com) and:
13
13
  ### 2. Run the setup command
14
14
 
15
15
  ```bash
16
- npx @scry/storybook-deployer init --projectId YOUR_PROJECT_ID --apiKey YOUR_API_KEY
16
+ npx @scrymore/scry-deployer init --projectId YOUR_PROJECT_ID --apiKey YOUR_API_KEY
17
17
  ```
18
18
 
19
19
  **That's it!** 🎉
@@ -61,7 +61,7 @@ This tool is designed for execution within a CI/CD pipeline (such as GitHub Acti
61
61
  Want to test a deployment before setting up automation? Run:
62
62
 
63
63
  ```bash
64
- npx @scry/storybook-deployer --dir ./storybook-static --project YOUR_PROJECT_ID --api-key YOUR_API_KEY
64
+ npx @scrymore/scry-deployer --dir ./storybook-static --project YOUR_PROJECT_ID --api-key YOUR_API_KEY
65
65
  ```
66
66
 
67
67
  This deploys your Storybook immediately without setting up GitHub Actions.
@@ -74,7 +74,7 @@ This deploys your Storybook immediately without setting up GitHub Actions.
74
74
 
75
75
  ```bash
76
76
  # From npm (recommended)
77
- npx @scry/storybook-deployer init --projectId xxx --apiKey yyy
77
+ npx @scrymore/scry-deployer init --projectId xxx --apiKey yyy
78
78
 
79
79
  # From GitHub (latest from main branch)
80
80
  npx github:epinnock/scry-node init --projectId xxx --apiKey yyy
@@ -86,7 +86,7 @@ If you prefer to install it as a development dependency:
86
86
 
87
87
  ```bash
88
88
  # From npm (when published)
89
- npm install @scry/storybook-deployer --save-dev
89
+ npm install @scrymore/scry-deployer --save-dev
90
90
 
91
91
  # From GitHub
92
92
  npm install github:epinnock/scry-node --save-dev
@@ -839,7 +839,7 @@ gh auth login
839
839
 
840
840
  Or skip GitHub CLI setup and set variables manually:
841
841
  ```bash
842
- npx @scry/storybook-deployer init --projectId xxx --apiKey yyy --skip-gh-setup
842
+ npx @scrymore/scry-deployer init --projectId xxx --apiKey yyy --skip-gh-setup
843
843
  ```
844
844
 
845
845
  Then manually add variables in GitHub Settings → Secrets and variables → Actions.
@@ -881,6 +881,64 @@ git push
881
881
 
882
882
  ---
883
883
 
884
+ ## 👩‍💻 Contributing & Development
885
+
886
+ We use [Changesets](https://github.com/changesets/changesets) for version management and releases.
887
+
888
+ ### Development Workflow
889
+
890
+ ```bash
891
+ # 1. Create a feature branch
892
+ git checkout main && git pull
893
+ git checkout -b feature/my-new-feature
894
+
895
+ # 2. Make your changes
896
+ # ... edit files ...
897
+
898
+ # 3. Create a changeset (if your changes should be released)
899
+ pnpm changeset
900
+ # Select @scrymore/scry-deployer
901
+ # Choose: patch (bug fix), minor (feature), major (breaking)
902
+ # Write a description of your changes
903
+
904
+ # 4. Commit everything
905
+ git add .
906
+ git commit -m "feat: add new feature"
907
+
908
+ # 5. Push and create a PR
909
+ git push -u origin HEAD
910
+ ```
911
+
912
+ ### When to Create a Changeset
913
+
914
+ | Change Type | Changeset? | Version Bump |
915
+ |-------------|------------|--------------|
916
+ | Bug fix | ✅ Yes | `patch` (0.0.1 → 0.0.2) |
917
+ | New feature | ✅ Yes | `minor` (0.0.2 → 0.1.0) |
918
+ | Breaking change | ✅ Yes | `major` (0.1.0 → 1.0.0) |
919
+ | Documentation only | ❌ No | - |
920
+ | CI/workflow changes | ❌ No | - |
921
+
922
+ ### Release Process
923
+
924
+ 1. **Merge PR to main** → Release workflow runs
925
+ 2. **Changesets bot creates "Version Packages" PR** → Updates version + CHANGELOG
926
+ 3. **Merge Version PR** → Publishes to npm automatically
927
+
928
+ ### Installing Development Versions
929
+
930
+ ```bash
931
+ # Stable release (recommended)
932
+ npm install @scrymore/scry-deployer
933
+
934
+ # Nightly release (latest from main, published daily)
935
+ npm install @scrymore/scry-deployer@nightly
936
+ ```
937
+
938
+ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed contribution guidelines.
939
+
940
+ ---
941
+
884
942
  ## 🆘 Support
885
943
 
886
944
  Need help?
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scrymore/scry-deployer",
3
- "version": "0.0.2",
3
+ "version": "0.0.3",
4
4
  "description": "A CLI to automate the deployment of Storybook static builds.",
5
5
  "main": "index.js",
6
6
  "bin": {