Skip to content

Commit 994f2ca

Browse files
committed
Update README
1 parent 8f23b84 commit 994f2ca

File tree

2 files changed

+24
-15
lines changed

2 files changed

+24
-15
lines changed

.github/workflows/deploy.yml

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,9 @@ jobs:
2929
- name: Build
3030
run: npm run build
3131

32-
- name: Setup Pages
33-
uses: actions/configure-pages@v4
34-
35-
- name: Upload artifact
36-
uses: actions/upload-pages-artifact@v3
37-
with:
38-
path: './demo'
39-
4032
- name: Deploy to GitHub Pages
4133
if: github.ref == 'refs/heads/main'
42-
id: deployment
43-
uses: actions/deploy-pages@v4
34+
uses: peaceiris/actions-gh-pages@v3
35+
with:
36+
github_token: ${{ secrets.GITHUB_TOKEN }}
37+
publish_dir: ./demo

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,37 @@
1-
# pocket-camera
1+
# Pocket Camera
22

3-
Nintendo Game Boy Camera filter for your webcam.
3+
Web-component that transforms your webcam into a Nintendo Game Boy Camera with authentic dithering and 4-color green palette. A nostalgic filter that recreates the iconic 1998 handheld camera experience.
4+
5+
Originally created in 2022 as a colorblind accessibility experiment.
46

57
## Usage
68

9+
I have no plans to publish this as a package because there isn't much code. If you want to use it, copy the source code directly into your project - either the whole web component or just the processing function.
10+
11+
Copy these files:
12+
- `src/PocketCamera.ts` - Main web-component
13+
- `src/processing.ts` - Image processing function
714

8-
## Attributes
15+
## Component attributes
916

1017
- `width` - Canvas width (default: 320)
1118
- `height` - Canvas height (default: 240)
1219
- `auto-start` - Start camera automatically
1320

1421
## Demo
1522

16-
`npm run dev`
23+
```bash
24+
npm run dev
25+
```
1726

1827
Visit `http://localhost:8000/demo/`
1928

2029
## Build
2130

22-
`npm run build`
31+
```bash
32+
npm run build
33+
```
34+
35+
## License
36+
37+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)