heroshot 0.5.0 → 0.7.0

package/README.md

@@ -18,24 +18,22 @@ The manual fix is tedious: open browser, navigate, log in, screenshot, crop, sav
 
 **Heroshot fixes this.** Define your screenshots once - point and click, no CSS selectors - and regenerate them with one command whenever you need.
 
+```bash
+npx heroshot
+```
+
+First run opens a browser with a visual picker. Click what you want, name it, done. Screenshots land in `heroshots/`, config saves to `.heroshot/config.json`. Next run regenerates everything headlessly.
+
 <table align="center">
   <tr>
-    <th></th>
-    <th>Light</th>
-    <th>Dark</th>
-  </tr>
-  <tr>
-    <th>Desktop</th>
     <td><img src="https://github.com/omachala/heroshot/blob/main/docs/public/screenshots/hero-desktop-light.png?raw=true" alt="Desktop Light"></td>
     <td><img src="https://github.com/omachala/heroshot/blob/main/docs/public/screenshots/hero-desktop-dark.png?raw=true" alt="Desktop Dark"></td>
   </tr>
   <tr>
-    <th>Tablet</th>
     <td><img src="https://github.com/omachala/heroshot/blob/main/docs/public/screenshots/hero-tablet-light.png?raw=true" alt="Tablet Light"></td>
     <td><img src="https://github.com/omachala/heroshot/blob/main/docs/public/screenshots/hero-tablet-dark.png?raw=true" alt="Tablet Dark"></td>
   </tr>
   <tr>
-    <th>Mobile</th>
     <td><img src="https://github.com/omachala/heroshot/blob/main/docs/public/screenshots/hero-mobile-light.png?raw=true" alt="Mobile Light"></td>
     <td><img src="https://github.com/omachala/heroshot/blob/main/docs/public/screenshots/hero-mobile-dark.png?raw=true" alt="Mobile Dark"></td>
   </tr>
@@ -43,17 +41,9 @@ The manual fix is tedious: open browser, navigate, log in, screenshot, crop, sav
 
 <p align="center"><em>6 screenshots from one config entry - always in sync with the live site.</em></p>
 
-## Get Started
-
-```bash
-npx heroshot
-```
-
-First run opens a browser with a visual picker. Click what you want, name it, done. Screenshots land in `heroshots/`, config saves to `.heroshot/config.json`. Next run regenerates everything headlessly.
-
 ## Use in Your Docs
 
-**VitePress**
+**VitePress** · [Full guide](https://heroshot.sh/docs/integrations/vitepress)
 
 ```ts
 // .vitepress/config.ts
@@ -62,26 +52,26 @@ export default defineConfig({ vite: { plugins: [heroshot()] } });
 ```
 
 ```vue
+<script setup>
+import { Heroshot } from 'heroshot/vue';
+</script>
+
 <Heroshot name="dashboard" alt="Dashboard" />
 ```
 
-**Docusaurus**
+**Docusaurus** · [Full guide](https://heroshot.sh/docs/integrations/docusaurus)
 
 ```js
 // docusaurus.config.js
 plugins: [['heroshot/plugins/docusaurus', {}]];
 ```
 
-```mdx
+```tsx
 import { Heroshot } from 'heroshot/docusaurus';
-<Heroshot name="dashboard" alt="Dashboard" />
+<Heroshot name="dashboard" alt="Dashboard" />;
 ```
 
-**MkDocs**
-
-```bash
-pip install heroshot
-```
+**MkDocs** · [Full guide](https://heroshot.sh/docs/integrations/mkdocs)
 
 ```yaml
 # mkdocs.yml
@@ -96,53 +86,21 @@ plugins:
 
 One component/macro, all variants - light/dark mode switches automatically, responsive sizes via srcset.
 
-## Automated Updates
-
-Keep screenshots always current by running heroshot in CI. Quick setup:
-
-```bash
-# Get your session key (for authenticated sites)
-npx heroshot session-key
-
-# Add to GitHub secrets
-gh secret set HEROSHOT_SESSION_KEY
-```
-
-Then create `.github/workflows/heroshot.yml`:
-
-```yaml
-name: Update Screenshots
-
-on:
-  workflow_dispatch:
-
-jobs:
-  screenshots:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-      - run: npx heroshot
-        env:
-          HEROSHOT_SESSION_KEY: ${{ secrets.HEROSHOT_SESSION_KEY }}
-      - run: |
-          git config user.name "github-actions[bot]"
-          git config user.email "github-actions[bot]@users.noreply.github.com"
-          git add heroshots/
-          git diff --staged --quiet || git commit -m "chore: update screenshots" && git push
-```
-
-Go to Actions → Update Screenshots → Run workflow. Done.
+## Learn More
 
-For more options (scheduled runs, PR creation, debugging), see the [full CI guide](https://heroshot.sh/docs/guide/automated-updates).
+|                     |                                                                       |
+| ------------------- | --------------------------------------------------------------------- |
+| **Documentation**   | [heroshot.sh](https://heroshot.sh)                                    |
+| **Getting Started** | [Quick start guide](https://heroshot.sh/docs/getting-started)         |
+| **Configuration**   | [Config options](https://heroshot.sh/docs/config)                     |
+| **CI/CD Setup**     | [Automated updates](https://heroshot.sh/docs/guide/automated-updates) |
+| **CLI Reference**   | [All commands & flags](https://heroshot.sh/docs/cli)                  |
 
-## Learn More
+## Contributing
 
-**Docs:** [heroshot.sh](https://heroshot.sh)
+This is a community project aiming to solve screenshot automation end-to-end and any feedback is valuable. Open an [issue](https://github.com/omachala/heroshot/issues) for bugs, questions, or feature requests. Pull requests are more than welcome.
 
-**Status:** Early alpha. [See releases](https://github.com/omachala/heroshot/releases) for current version.
+If you like it, give the repo a ⭐
 
 ## License