Skip to content

Commit be6fda3

Browse files
authored
Merge pull request #47 from chronon/f/update-readme
f/update readme
2 parents 7597a10 + b13ede6 commit be6fda3

File tree

4 files changed

+69
-397
lines changed

4 files changed

+69
-397
lines changed

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,7 @@ Both commands MUST pass or CI will fail.
438438

439439
- **Adding features**: Follow existing patterns in `src/routes/` and `src/lib/`
440440
- **Styling changes**: Use Tailwind CSS classes, follow existing component patterns
441-
- **Database changes**: Create new migration in `migrations/`, apply with `wrangler d1 migrations apply`
441+
- **Database changes**: Create new migration in `migrations/`, apply with `pnpm wrangler d1 migrations apply`
442442
- **API changes**: Update TypeScript interfaces in `src/lib/config.ts`
443443
- **Adding users**: Create Cloudflare Access service token, edit `config/app.jsonc` with domain and authorized client IDs, then run `pnpm deploy`
444444
- **Adding admin endpoints**: Place under `/admin/*` path to use centralized authentication, access user info via `locals.adminAuth`, use shared utilities from `src/lib/admin-utils.ts` for validation and error handling

CLAUDE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,14 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
2929

3030
- Use `pnpm check` and `pnpm lint` before committing changes
3131

32+
### Documentation
33+
34+
When asked to "update docs", update all of the following files:
35+
36+
- `README.md` - User-facing documentation
37+
- `CLAUDE.md` - This file, guidance for Claude Code
38+
- `.github/copilot-instructions.md` - Instructions for GitHub Copilot
39+
3240
## Architecture
3341

3442
This is a multi-user, domain-based photo gallery application built with SvelteKit and deployed on Cloudflare Workers. Each domain automatically displays a different user's photos using Cloudflare KV for configuration and Cloudflare D1 for image metadata storage.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Gregory Gaskill
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)