Update changelog, add AGENTS.md, remove CLAUDE.md
This commit is contained in:
@@ -0,0 +1,29 @@
|
||||
# AGENTS.md
|
||||
|
||||
Project notes for coding agents working in this repo.
|
||||
|
||||
## Commands
|
||||
|
||||
- Install: `pnpm install`
|
||||
- Typecheck (acts as tests): `pnpm test`
|
||||
- Build: `pnpm build`
|
||||
- Dev: `pnpm dev`
|
||||
|
||||
## Conventions
|
||||
|
||||
- Use 2-space indentation.
|
||||
- Keep changes scoped: one logical change per commit.
|
||||
- Commit messages: concise, one line, sentence case. No emojis. No "Co-Authored-By".
|
||||
- Update `CHANGELOG.md` for user-visible changes (topmost entry).
|
||||
|
||||
## Repo Layout
|
||||
|
||||
- `src/App.tsx` is the main app shell.
|
||||
- `src/components/` holds UI components and modals.
|
||||
- `src/lib/` holds parsing + logic:
|
||||
- `src/lib/epub.ts` for EPUB parsing and optional Open Library metadata.
|
||||
- `src/lib/pdf.ts` for PDF text extraction.
|
||||
- `src/lib/storage.ts` for localStorage + iOS/fullscreen helpers.
|
||||
- `src/lib/reading.ts` for RSVP timing/ORP helpers.
|
||||
- `src/vendor/pdfjs/` vendors PDF.js ESM + worker for offline-friendly PDF parsing (see LICENSE in that folder).
|
||||
|
||||
+23
-18
@@ -1,35 +1,40 @@
|
||||
### 2026-02-07: 1.1.0
|
||||
|
||||
- Split the big app file into smaller TypeScript modules and add `tsc` typechecking
|
||||
- Add PDF upload support (extract all text client-side for speed reading)
|
||||
|
||||
### 2026-02-02: 1.0.5
|
||||
|
||||
* Add fullscreen button for desktop browsers
|
||||
* Add PWA support with manifest for standalone mode
|
||||
* Add iOS install banner prompting Add to Home Screen for fullscreen experience
|
||||
- Add fullscreen button for desktop browsers
|
||||
- Add PWA support with manifest for standalone mode
|
||||
- Add iOS install banner prompting Add to Home Screen for fullscreen experience
|
||||
|
||||
### 2026-02-01: 1.0.4
|
||||
|
||||
* Improve mobile responsiveness and book metadata layout
|
||||
* Fix words per display setting and limit max to 3
|
||||
* Add copy link button to share reading position across devices
|
||||
- Improve mobile responsiveness and book metadata layout
|
||||
- Fix words per display setting and limit max to 3
|
||||
- Add copy link button to share reading position across devices
|
||||
|
||||
### 2026-02-01: 1.0.3
|
||||
|
||||
* Add mobile responsiveness
|
||||
* Fix modal accessibility
|
||||
* Fix progress bar accessibility
|
||||
* Add Open Library API integration for missing book metadata (opt-in)
|
||||
- Add mobile responsiveness
|
||||
- Fix modal accessibility
|
||||
- Fix progress bar accessibility
|
||||
- Add Open Library API integration for missing book metadata (opt-in)
|
||||
|
||||
### 2026-02-01: 1.0.2
|
||||
|
||||
* Convert book metadata to semantic HTML for accessibility
|
||||
* Add reading time to book metadata display
|
||||
* Improve book info readability
|
||||
- Convert book metadata to semantic HTML for accessibility
|
||||
- Add reading time to book metadata display
|
||||
- Improve book info readability
|
||||
|
||||
### 2026-02-01: 1.0.1
|
||||
|
||||
* Persist book metadata to localStorage
|
||||
- Persist book metadata to localStorage
|
||||
|
||||
### 2026-02-01: 1.0.0
|
||||
|
||||
* Add dark/light mode support to favicon
|
||||
* Change app title to sentence case
|
||||
* Open CHANGELOG.md
|
||||
* Release v1.0.0
|
||||
- Add dark/light mode support to favicon
|
||||
- Change app title to sentence case
|
||||
- Open CHANGELOG.md
|
||||
- Release v1.0.0
|
||||
|
||||
@@ -1,24 +0,0 @@
|
||||
## Commits and code style
|
||||
|
||||
- 2 space indents
|
||||
- Always commit build and asset files
|
||||
- One logical change per commit
|
||||
- Keep commit messages concise (one line), use sentence case
|
||||
- Update CHANGELOG.md after each change
|
||||
- Use present tense in commits and CHANGELOG.md
|
||||
- Use sentence case for headings (not Title Case)
|
||||
- Never use bold text as headings, use proper heading levels instead
|
||||
- Always add an empty line after headings
|
||||
- No formatting in CHANGELOG.md except `inline code` and when absolute necessary
|
||||
- Use `*` as bullets in CHANGELOG.md
|
||||
- Never use Claude watermark in commits (FORBIDDEN: "Co-Authored-By")
|
||||
- No emojis in commits or code
|
||||
- Keep CHANGELOG.md date up to date when adding entries
|
||||
|
||||
## Claude Code workflow
|
||||
|
||||
- Always add tasks to the Claude Code to-do list and keep it up to date. Show todo list to user.
|
||||
- Review your to-do list and prioritize before starting.
|
||||
- If new tasks come in, don't jump to them right away—add them to the list in order of urgency and finish your current work first. Use FIFO (First in First out) in order.
|
||||
- Do not ever guess features, always proof them via looking up official docs, GitHub code, issues, if possible.
|
||||
- When looking things up, do not use years in search terms like 2024 or 2025.
|
||||
@@ -1,6 +1,6 @@
|
||||
# ⚡ Speed reader
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ A web-based speed reading tool using Rapid Serial Visual Presentation (RSVP) wit
|
||||
## Features
|
||||
|
||||
- Privacy-first, offline-first
|
||||
- EPUB and TXT file support
|
||||
- EPUB, PDF, and TXT file support
|
||||
- Settings and progress persisted to localStorage
|
||||
|
||||
<img width="1201" height="990" alt="localhost_5179_" src="https://github.com/user-attachments/assets/36ceee75-44fe-4852-a05a-e9dfa1a7a9c8" />
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "speed-reader",
|
||||
"private": true,
|
||||
"version": "1.0.5",
|
||||
"version": "1.0.6",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"dev": "vite",
|
||||
|
||||
Reference in New Issue
Block a user