studydesk 1.2.0__tar.gz

studydesk-1.2.0/.gitignore

@@ -0,0 +1,14 @@
+node_modules/
+dist/
+target/
+.DS_Store
+Thumbs.db
+*.log
+.env
+# personal test PDFs
+samples/*.pdf
+
+# Python packaging
+__pycache__/
+*.egg-info/
+.venv/

studydesk-1.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Subham Divakar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

studydesk-1.2.0/PKG-INFO

@@ -0,0 +1,260 @@
+Metadata-Version: 2.5
+Name: studydesk
+Version: 1.2.0
+Summary: A local-first workspace for reading research papers: PDF reader, highlights, notes, search and a history of your reading.
+Project-URL: Homepage, https://github.com/shubham10divakar/studydesk
+Project-URL: Source, https://github.com/shubham10divakar/studydesk
+Project-URL: Issues, https://github.com/shubham10divakar/studydesk/issues
+Project-URL: Roadmap, https://github.com/shubham10divakar/studydesk/blob/main/docs/roadmap.md
+Author: Subham Divakar
+License-Expression: MIT
+License-File: LICENSE
+Keywords: local-first,notes,papers,pdf,reader,research
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# StudyDesk
+
+### Your reading desk for research papers.
+
+**Library, PDF reader, highlights, notes, and a complete log of your reading, all in one window, all on your machine.**
+
+[![PyPI](https://img.shields.io/pypi/v/studydesk?color=2f55d4&label=pypi)](https://pypi.org/project/studydesk/)
+[![Downloads](https://img.shields.io/pepy/dt/studydesk?label=downloads)](https://pepy.tech/projects/studydesk)
+[![Downloads / month](https://img.shields.io/pypi/dm/studydesk?label=downloads%2Fmonth)](https://pypistats.org/packages/studydesk)
+[![Python](https://img.shields.io/pypi/pyversions/studydesk)](https://pypi.org/project/studydesk/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green)](https://github.com/shubham10divakar/studydesk/blob/main/LICENSE)
+
+```bash
+pip install studydesk && studydesk
+```
+
+<img src="https://raw.githubusercontent.com/shubham10divakar/studydesk/main/docs/assets/overview.png" alt="StudyDesk overview: reading stats, continue reading, reading calendar, up next and revision queue" width="100%">
+
+</div>
+
+> [!NOTE]
+> **StudyDesk was called PDFDesk.** It is growing from a PDF reader into a desk for everything you study: links, PDFs, documents and notes. Coming from `pdfdesk`? Run `pip install studydesk && studydesk`: your library in `~/PDFDesk` is used as it is, nothing to export or move. `pdfdesk` 1.1.1 was the last release under the old name.
+
+---
+
+## New in 1.1
+
+- 🔗 **Add a paper by link, without the PDF:** found it on Google Scholar but can't get the PDF? Keep the link, abstract, tags and notes now (paste Scholar's BibTeX to fill in the details) and attach the PDF later.
+- 🏷️ **Tags suggest themselves:** your existing tags are listed as you type, most used first.
+- 📝 **Abstracts** for every paper, included in search.
+
+## New in 1.0
+
+- 🔗 **Links in your PDFs work:** citations, figure and section references jump to the exact spot, and **Back** (`Alt+←`) returns you.
+- 📑 **Contents tab** from the paper's own outline, marking the section you're reading.
+- 🔎 **Search everything:** titles, authors, tags, and inside your highlights, comments, notes and session takeaways.
+- ➕ **Add by arXiv ID or DOI:** paste `1706.03762` and the paper arrives with its details and PDF.
+- 🖍️ **Highlights survive a new PDF version:** replace the file and they find their text again.
+- 🧭 **Panel and page are connected:** click a highlight on the page to open it, or in the panel to see it on the page.
+- ↔️ **Room to read:** hide the sidebar and the notes panel with `[` and `]`.
+- ✏️ **Fix a session** logged by mistake.
+
+Full list in [CHANGELOG.md](https://github.com/shubham10divakar/studydesk/blob/main/CHANGELOG.md).
+
+## Why StudyDesk
+
+You read dozens of papers a month. A file manager tells you **where** a PDF lives. An annotation tool tells you **what** you marked. Neither tells you **how you read it**: when you opened it, how far you got, how long you actually spent, and what you concluded at the end of each sitting.
+
+StudyDesk keeps that record for you. Every paper moves through a reading lifecycle, every sitting becomes a session, and every highlight and note links back to the page it came from. Months later you can see what you read and why it mattered.
+
+<table>
+<tr>
+<td width="33%" valign="top">
+
+### 📚 Organise
+A library that knows where each paper is in your reading, from *Inbox* to *Completed*.
+
+</td>
+<td width="33%" valign="top">
+
+### 🖍️ Read & annotate
+A fast PDF reader with colour-coded highlights and Markdown notes that link to pages.
+
+</td>
+<td width="33%" valign="top">
+
+### 📈 Remember
+Sessions, a reading calendar, streaks and a daily revision queue bring papers back.
+
+</td>
+</tr>
+</table>
+
+---
+
+## Read with highlights that mean something
+
+<img src="https://raw.githubusercontent.com/shubham10divakar/studydesk/main/docs/assets/reader-highlights.png" alt="StudyDesk reader with colour-coded highlights and the highlights panel" width="100%">
+
+Select text on any page and pick a colour. Each colour has one job, so a page of highlights reads at a glance:
+
+| | Colour | Meaning |
+|---|---|---|
+| 🟨 | Yellow | Key idea |
+| 🟩 | Green | Method or result |
+| 🟦 | Blue | Definition |
+| 🟥 | Pink | Question or doubt |
+
+- Add a comment to any highlight, and filter the panel by colour.
+- **Links work like in a PDF reader:** click a citation, a section or figure reference, or a contents entry to jump to the exact spot; web links open in a new tab. After following a link, **Back to p. N** (or `Alt+←`) returns you to exactly where you were.
+- Click a highlight in the panel to jump straight to it in the PDF: it scrolls to the page and flashes. It works the other way too: click a highlight on the page and the panel opens at it, ready for a comment.
+- Highlights store the selected text as well as their position, so they stay put when you zoom.
+- **Got a newer version of the PDF?** Replace it and your highlights find their text again, even on a different page or slightly reworded. Any that can't be found are kept and marked.
+- **Extract to notes** pulls every highlight into your notes, each with its page reference.
+- **Contents tab:** the PDF's own outline, with the section you're reading marked. Click a section to jump there.
+- **Make room for the page:** hide the sidebar and the notes panel (`[` and `]`, or the buttons at either end of the toolbar) and wide pages and slides get the full width.
+
+## Notes that point back to the page
+
+<img src="https://raw.githubusercontent.com/shubham10divakar/studydesk/main/docs/assets/reader-notes.png" alt="StudyDesk notes panel with Markdown and page links next to the PDF" width="100%">
+
+- Write in **Markdown**: headings, bullets, quotes.
+- Type `p. 12` anywhere and it becomes a link to page 12. When the line quotes one of your highlights, the link takes you to that exact highlight.
+- **Cite p. N** drops in a reference to the page you're on.
+- **Insert highlights** adds your highlights to the notes, each with its page.
+- **Copy** exports the notes as Markdown, ready for your paper, wiki or Obsidian vault.
+- Notes save automatically as you type.
+
+## A library that follows your reading
+
+<img src="https://raw.githubusercontent.com/shubham10divakar/studydesk/main/docs/assets/library.png" alt="StudyDesk library with status, progress, last read and tags for each paper" width="100%">
+
+Every paper has a place in the reading lifecycle:
+
+**Inbox → Planned → Reading → Paused → Completed → Revisit**
+
+- Opening a paper moves it to *Reading*. When you reach the last page, StudyDesk asks whether it's *Completed* or worth a *Revisit*. Papers saved as a link stay where you put them until you attach the PDF.
+- **Import** by button or drag and drop. Title, authors and page count come from the PDF itself.
+- **Search everything** from the sidebar: titles, authors, tags and abstracts, and inside your highlights, comments, notes and session takeaways. Each result opens the right page.
+- **Add by arXiv ID or DOI:** paste `1706.03762` or a DOI, and the title, authors, year and venue are filled in. arXiv papers come with their PDF.
+- **Add by link, without the PDF:** found a paper on Google Scholar but can't get the PDF? Save its link, abstract, tags and notes now (paste Scholar's BibTeX to fill in the details) and attach the PDF later. Such papers wait in a *No PDF yet* list.
+- **Tags** in the sidebar, with counts, for one-click filtering. When you tag a paper, your existing tags are suggested as you type.
+- See each paper's status, progress bar, pages read and when you last opened it.
+- Set a **target page and date** ("finish section 3 by Friday") and it shows up in *Up next*.
+
+## Every session, recorded
+
+StudyDesk logs each sitting with a paper on its own:
+
+- **Active time only.** The clock pauses when the tab is hidden or you've been idle for 3 minutes, so your stats count reading, not open tabs.
+- **Pages covered**: the first and last page you reached.
+- **A takeaway**: an optional line on what you got out of the session.
+- **Resume where you left off**: every paper reopens at your last page.
+- **Bookmarks** for pages you'll come back to.
+- **Fix a session** logged by mistake: edit its pages, minutes or takeaway, or delete it.
+- Papers saved as a link, without the PDF, don't record sessions: there's nothing to read yet. Sessions start once you attach the PDF.
+
+## Your reading, at a glance
+
+The overview turns your sessions into a picture of your reading:
+
+- **Stats**: papers in your library, reading now, completed, time and pages this week.
+- **Continue reading**: papers in progress, with a progress bar and a one-click resume.
+- **Reading calendar**: a 17-week heatmap of your reading days, with your current streak and total hours.
+- **Up next**: planned and paused papers, sorted by target date.
+- **Revision queue**: highlights from finished papers come back each day, so ideas don't fade.
+- **Reading log**: every session, newest first.
+
+## Back up and move your library
+
+- **Export library** saves everything in one `.zip`: your PDFs, highlights, comments, notes, sessions and bookmarks, plus a readable Markdown file for every paper with its link, abstract, notes and highlights.
+- **Export without PDFs** makes a small backup file for frequent saves.
+- **Import library** shows what's in the file before changing anything. *Add to my library* merges and never deletes or overwrites what you wrote; *Replace my library* asks first and offers to export your current library.
+- Drop an export file on the window to import it. Use it to move to another browser or computer.
+
+## Easy on the eyes, day and night
+
+<img src="https://raw.githubusercontent.com/shubham10divakar/studydesk/main/docs/assets/reader-dark.png" alt="StudyDesk reader in dark mode" width="100%">
+
+Dark mode follows your system setting. Typography is set for long reading sessions: Source Serif 4 for titles and notes, IBM Plex Sans for the interface, IBM Plex Mono for numbers and page references.
+
+## Keyboard shortcuts
+
+| Key | Action |
+|---|---|
+| `j` or `→` | Next page |
+| `k` or `←` | Previous page |
+| `b` | Bookmark this page |
+| `Alt+←` | Back to where you were before following a link |
+| `[` | Show or hide the sidebar |
+| `]` | Show or hide notes and highlights |
+| `Enter` in the page box | Jump to page |
+| `Esc` | Close the highlight menu |
+| `Enter` or `,` in a tag box | Add the suggested tag (or a new one); `↑` `↓` choose, `Backspace` removes the last tag |
+
+---
+
+## Private by design
+
+- 🔒 **Local-first.** Your library is a normal folder on your computer: real PDF files, a `library.json`, and a backup every day. No account, no cloud, no tracking.
+- 🗂️ **One library, everywhere on your machine.** Any browser and any port shows the same library, and clearing browser data deletes nothing.
+- ✈️ **Works offline.** The PDF engine and fonts ship inside the package. Nothing loads from the internet.
+- 🪶 **Lightweight.** One small package with **zero Python dependencies**. If you have Python 3.9+, you can run it.
+
+## Get started
+
+```bash
+pip install studydesk
+studydesk
+```
+
+StudyDesk opens in your browser at **http://localhost:5173**. A few example papers are loaded so you can explore. Remove them from the sidebar when you're ready, then drop in your own PDFs, add papers by arXiv ID or DOI, or save one by its link when you can't get the PDF.
+
+```bash
+studydesk --no-browser            # start without opening a browser window
+studydesk --port 8080             # use another port (same library)
+studydesk --data-dir D:\Papers    # keep the library somewhere else
+studydesk --version
+```
+
+Upgrade any time with `pip install -U studydesk`.
+
+> **Where your library lives:** in a folder called `StudyDesk` in your home folder (`studydesk` prints the exact path; click it in the sidebar or on the About page to open the folder). It holds `library.json`, your PDFs in `pdfs/`, and daily backups in `backups/`. Adding a PDF saves a copy there; your original file stays where it is. Uninstalling the package doesn't touch the folder. Use **Export library** to move it to another computer.
+
+## What's coming
+
+StudyDesk is at **1.1**. Next up:
+
+- **Recolour instead of duplicate:** highlighting text that's already highlighted will offer to change its colour.
+- **Reference preview:** hover over a citation to read the reference without jumping.
+- **StudyDesk 2.0** as a native desktop app (Tauri + SQLite), installed the same way, with `pip install -U studydesk`.
+- Later: links between papers, spaced revision, weekly reading reports, Zotero import.
+
+The full plan is in [docs/roadmap.md](https://github.com/shubham10divakar/studydesk/blob/main/docs/roadmap.md).
+
+## Feedback and contact
+
+StudyDesk is built by **Subham Divakar**, a software engineer and ML researcher. I built it for myself: I read a lot of papers and kept losing track of what I'd read, how far I got and why it mattered. So I built a tool for complete note-making across PDFs and slide decks. I've made notes in it every day for over two years. People who saw it loved it, so here it is: a small version of that tool. More features are on the way.
+
+Found a bug, want a feature, or have a question? Open an [issue](https://github.com/shubham10divakar/studydesk/issues) or reach out:
+
+[Website](https://subhamdivakar.com/) · [LinkedIn](https://www.linkedin.com/in/subham-divakar-a7420a12a/) · [Google Scholar](https://scholar.google.com/citations?user=44ecZj0AAAAJ&hl=en) · [GitHub](https://github.com/shubham10divakar) · [PyPI](https://pypi.org/user/shubham10divakar/)
+
+The **About** page inside the app has the same links.
+
+## Contributing
+
+Bug reports and ideas are welcome in [Issues](https://github.com/shubham10divakar/studydesk/issues). To work on the code, start with [DEVELOPMENT.md](https://github.com/shubham10divakar/studydesk/blob/main/DEVELOPMENT.md).
+
+## License
+
+[MIT](https://github.com/shubham10divakar/studydesk/blob/main/LICENSE). Bundled third-party code keeps its own licence: [PDF.js](https://mozilla.github.io/pdf.js/) (Apache-2.0) and the Source Serif 4, IBM Plex Sans and IBM Plex Mono fonts (SIL Open Font License 1.1).
+
+<div align="center">
+<br>
+<sub>Built by Subham Divakar with ❤️ for people who read papers for a living.</sub>
+</div>

studydesk-1.2.0/README.md

@@ -0,0 +1,239 @@
+<div align="center">
+
+# StudyDesk
+
+### Your reading desk for research papers.
+
+**Library, PDF reader, highlights, notes, and a complete log of your reading, all in one window, all on your machine.**
+
+[![PyPI](https://img.shields.io/pypi/v/studydesk?color=2f55d4&label=pypi)](https://pypi.org/project/studydesk/)
+[![Downloads](https://img.shields.io/pepy/dt/studydesk?label=downloads)](https://pepy.tech/projects/studydesk)
+[![Downloads / month](https://img.shields.io/pypi/dm/studydesk?label=downloads%2Fmonth)](https://pypistats.org/packages/studydesk)
+[![Python](https://img.shields.io/pypi/pyversions/studydesk)](https://pypi.org/project/studydesk/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green)](https://github.com/shubham10divakar/studydesk/blob/main/LICENSE)
+
+```bash
+pip install studydesk && studydesk
+```
+
+<img src="https://raw.githubusercontent.com/shubham10divakar/studydesk/main/docs/assets/overview.png" alt="StudyDesk overview: reading stats, continue reading, reading calendar, up next and revision queue" width="100%">
+
+</div>
+
+> [!NOTE]
+> **StudyDesk was called PDFDesk.** It is growing from a PDF reader into a desk for everything you study: links, PDFs, documents and notes. Coming from `pdfdesk`? Run `pip install studydesk && studydesk`: your library in `~/PDFDesk` is used as it is, nothing to export or move. `pdfdesk` 1.1.1 was the last release under the old name.
+
+---
+
+## New in 1.1
+
+- 🔗 **Add a paper by link, without the PDF:** found it on Google Scholar but can't get the PDF? Keep the link, abstract, tags and notes now (paste Scholar's BibTeX to fill in the details) and attach the PDF later.
+- 🏷️ **Tags suggest themselves:** your existing tags are listed as you type, most used first.
+- 📝 **Abstracts** for every paper, included in search.
+
+## New in 1.0
+
+- 🔗 **Links in your PDFs work:** citations, figure and section references jump to the exact spot, and **Back** (`Alt+←`) returns you.
+- 📑 **Contents tab** from the paper's own outline, marking the section you're reading.
+- 🔎 **Search everything:** titles, authors, tags, and inside your highlights, comments, notes and session takeaways.
+- ➕ **Add by arXiv ID or DOI:** paste `1706.03762` and the paper arrives with its details and PDF.
+- 🖍️ **Highlights survive a new PDF version:** replace the file and they find their text again.
+- 🧭 **Panel and page are connected:** click a highlight on the page to open it, or in the panel to see it on the page.
+- ↔️ **Room to read:** hide the sidebar and the notes panel with `[` and `]`.
+- ✏️ **Fix a session** logged by mistake.
+
+Full list in [CHANGELOG.md](https://github.com/shubham10divakar/studydesk/blob/main/CHANGELOG.md).
+
+## Why StudyDesk
+
+You read dozens of papers a month. A file manager tells you **where** a PDF lives. An annotation tool tells you **what** you marked. Neither tells you **how you read it**: when you opened it, how far you got, how long you actually spent, and what you concluded at the end of each sitting.
+
+StudyDesk keeps that record for you. Every paper moves through a reading lifecycle, every sitting becomes a session, and every highlight and note links back to the page it came from. Months later you can see what you read and why it mattered.
+
+<table>
+<tr>
+<td width="33%" valign="top">
+
+### 📚 Organise
+A library that knows where each paper is in your reading, from *Inbox* to *Completed*.
+
+</td>
+<td width="33%" valign="top">
+
+### 🖍️ Read & annotate
+A fast PDF reader with colour-coded highlights and Markdown notes that link to pages.
+
+</td>
+<td width="33%" valign="top">
+
+### 📈 Remember
+Sessions, a reading calendar, streaks and a daily revision queue bring papers back.
+
+</td>
+</tr>
+</table>
+
+---
+
+## Read with highlights that mean something
+
+<img src="https://raw.githubusercontent.com/shubham10divakar/studydesk/main/docs/assets/reader-highlights.png" alt="StudyDesk reader with colour-coded highlights and the highlights panel" width="100%">
+
+Select text on any page and pick a colour. Each colour has one job, so a page of highlights reads at a glance:
+
+| | Colour | Meaning |
+|---|---|---|
+| 🟨 | Yellow | Key idea |
+| 🟩 | Green | Method or result |
+| 🟦 | Blue | Definition |
+| 🟥 | Pink | Question or doubt |
+
+- Add a comment to any highlight, and filter the panel by colour.
+- **Links work like in a PDF reader:** click a citation, a section or figure reference, or a contents entry to jump to the exact spot; web links open in a new tab. After following a link, **Back to p. N** (or `Alt+←`) returns you to exactly where you were.
+- Click a highlight in the panel to jump straight to it in the PDF: it scrolls to the page and flashes. It works the other way too: click a highlight on the page and the panel opens at it, ready for a comment.
+- Highlights store the selected text as well as their position, so they stay put when you zoom.
+- **Got a newer version of the PDF?** Replace it and your highlights find their text again, even on a different page or slightly reworded. Any that can't be found are kept and marked.
+- **Extract to notes** pulls every highlight into your notes, each with its page reference.
+- **Contents tab:** the PDF's own outline, with the section you're reading marked. Click a section to jump there.
+- **Make room for the page:** hide the sidebar and the notes panel (`[` and `]`, or the buttons at either end of the toolbar) and wide pages and slides get the full width.
+
+## Notes that point back to the page
+
+<img src="https://raw.githubusercontent.com/shubham10divakar/studydesk/main/docs/assets/reader-notes.png" alt="StudyDesk notes panel with Markdown and page links next to the PDF" width="100%">
+
+- Write in **Markdown**: headings, bullets, quotes.
+- Type `p. 12` anywhere and it becomes a link to page 12. When the line quotes one of your highlights, the link takes you to that exact highlight.
+- **Cite p. N** drops in a reference to the page you're on.
+- **Insert highlights** adds your highlights to the notes, each with its page.
+- **Copy** exports the notes as Markdown, ready for your paper, wiki or Obsidian vault.
+- Notes save automatically as you type.
+
+## A library that follows your reading
+
+<img src="https://raw.githubusercontent.com/shubham10divakar/studydesk/main/docs/assets/library.png" alt="StudyDesk library with status, progress, last read and tags for each paper" width="100%">
+
+Every paper has a place in the reading lifecycle:
+
+**Inbox → Planned → Reading → Paused → Completed → Revisit**
+
+- Opening a paper moves it to *Reading*. When you reach the last page, StudyDesk asks whether it's *Completed* or worth a *Revisit*. Papers saved as a link stay where you put them until you attach the PDF.
+- **Import** by button or drag and drop. Title, authors and page count come from the PDF itself.
+- **Search everything** from the sidebar: titles, authors, tags and abstracts, and inside your highlights, comments, notes and session takeaways. Each result opens the right page.
+- **Add by arXiv ID or DOI:** paste `1706.03762` or a DOI, and the title, authors, year and venue are filled in. arXiv papers come with their PDF.
+- **Add by link, without the PDF:** found a paper on Google Scholar but can't get the PDF? Save its link, abstract, tags and notes now (paste Scholar's BibTeX to fill in the details) and attach the PDF later. Such papers wait in a *No PDF yet* list.
+- **Tags** in the sidebar, with counts, for one-click filtering. When you tag a paper, your existing tags are suggested as you type.
+- See each paper's status, progress bar, pages read and when you last opened it.
+- Set a **target page and date** ("finish section 3 by Friday") and it shows up in *Up next*.
+
+## Every session, recorded
+
+StudyDesk logs each sitting with a paper on its own:
+
+- **Active time only.** The clock pauses when the tab is hidden or you've been idle for 3 minutes, so your stats count reading, not open tabs.
+- **Pages covered**: the first and last page you reached.
+- **A takeaway**: an optional line on what you got out of the session.
+- **Resume where you left off**: every paper reopens at your last page.
+- **Bookmarks** for pages you'll come back to.
+- **Fix a session** logged by mistake: edit its pages, minutes or takeaway, or delete it.
+- Papers saved as a link, without the PDF, don't record sessions: there's nothing to read yet. Sessions start once you attach the PDF.
+
+## Your reading, at a glance
+
+The overview turns your sessions into a picture of your reading:
+
+- **Stats**: papers in your library, reading now, completed, time and pages this week.
+- **Continue reading**: papers in progress, with a progress bar and a one-click resume.
+- **Reading calendar**: a 17-week heatmap of your reading days, with your current streak and total hours.
+- **Up next**: planned and paused papers, sorted by target date.
+- **Revision queue**: highlights from finished papers come back each day, so ideas don't fade.
+- **Reading log**: every session, newest first.
+
+## Back up and move your library
+
+- **Export library** saves everything in one `.zip`: your PDFs, highlights, comments, notes, sessions and bookmarks, plus a readable Markdown file for every paper with its link, abstract, notes and highlights.
+- **Export without PDFs** makes a small backup file for frequent saves.
+- **Import library** shows what's in the file before changing anything. *Add to my library* merges and never deletes or overwrites what you wrote; *Replace my library* asks first and offers to export your current library.
+- Drop an export file on the window to import it. Use it to move to another browser or computer.
+
+## Easy on the eyes, day and night
+
+<img src="https://raw.githubusercontent.com/shubham10divakar/studydesk/main/docs/assets/reader-dark.png" alt="StudyDesk reader in dark mode" width="100%">
+
+Dark mode follows your system setting. Typography is set for long reading sessions: Source Serif 4 for titles and notes, IBM Plex Sans for the interface, IBM Plex Mono for numbers and page references.
+
+## Keyboard shortcuts
+
+| Key | Action |
+|---|---|
+| `j` or `→` | Next page |
+| `k` or `←` | Previous page |
+| `b` | Bookmark this page |
+| `Alt+←` | Back to where you were before following a link |
+| `[` | Show or hide the sidebar |
+| `]` | Show or hide notes and highlights |
+| `Enter` in the page box | Jump to page |
+| `Esc` | Close the highlight menu |
+| `Enter` or `,` in a tag box | Add the suggested tag (or a new one); `↑` `↓` choose, `Backspace` removes the last tag |
+
+---
+
+## Private by design
+
+- 🔒 **Local-first.** Your library is a normal folder on your computer: real PDF files, a `library.json`, and a backup every day. No account, no cloud, no tracking.
+- 🗂️ **One library, everywhere on your machine.** Any browser and any port shows the same library, and clearing browser data deletes nothing.
+- ✈️ **Works offline.** The PDF engine and fonts ship inside the package. Nothing loads from the internet.
+- 🪶 **Lightweight.** One small package with **zero Python dependencies**. If you have Python 3.9+, you can run it.
+
+## Get started
+
+```bash
+pip install studydesk
+studydesk
+```
+
+StudyDesk opens in your browser at **http://localhost:5173**. A few example papers are loaded so you can explore. Remove them from the sidebar when you're ready, then drop in your own PDFs, add papers by arXiv ID or DOI, or save one by its link when you can't get the PDF.
+
+```bash
+studydesk --no-browser            # start without opening a browser window
+studydesk --port 8080             # use another port (same library)
+studydesk --data-dir D:\Papers    # keep the library somewhere else
+studydesk --version
+```
+
+Upgrade any time with `pip install -U studydesk`.
+
+> **Where your library lives:** in a folder called `StudyDesk` in your home folder (`studydesk` prints the exact path; click it in the sidebar or on the About page to open the folder). It holds `library.json`, your PDFs in `pdfs/`, and daily backups in `backups/`. Adding a PDF saves a copy there; your original file stays where it is. Uninstalling the package doesn't touch the folder. Use **Export library** to move it to another computer.
+
+## What's coming
+
+StudyDesk is at **1.1**. Next up:
+
+- **Recolour instead of duplicate:** highlighting text that's already highlighted will offer to change its colour.
+- **Reference preview:** hover over a citation to read the reference without jumping.
+- **StudyDesk 2.0** as a native desktop app (Tauri + SQLite), installed the same way, with `pip install -U studydesk`.
+- Later: links between papers, spaced revision, weekly reading reports, Zotero import.
+
+The full plan is in [docs/roadmap.md](https://github.com/shubham10divakar/studydesk/blob/main/docs/roadmap.md).
+
+## Feedback and contact
+
+StudyDesk is built by **Subham Divakar**, a software engineer and ML researcher. I built it for myself: I read a lot of papers and kept losing track of what I'd read, how far I got and why it mattered. So I built a tool for complete note-making across PDFs and slide decks. I've made notes in it every day for over two years. People who saw it loved it, so here it is: a small version of that tool. More features are on the way.
+
+Found a bug, want a feature, or have a question? Open an [issue](https://github.com/shubham10divakar/studydesk/issues) or reach out:
+
+[Website](https://subhamdivakar.com/) · [LinkedIn](https://www.linkedin.com/in/subham-divakar-a7420a12a/) · [Google Scholar](https://scholar.google.com/citations?user=44ecZj0AAAAJ&hl=en) · [GitHub](https://github.com/shubham10divakar) · [PyPI](https://pypi.org/user/shubham10divakar/)
+
+The **About** page inside the app has the same links.
+
+## Contributing
+
+Bug reports and ideas are welcome in [Issues](https://github.com/shubham10divakar/studydesk/issues). To work on the code, start with [DEVELOPMENT.md](https://github.com/shubham10divakar/studydesk/blob/main/DEVELOPMENT.md).
+
+## License
+
+[MIT](https://github.com/shubham10divakar/studydesk/blob/main/LICENSE). Bundled third-party code keeps its own licence: [PDF.js](https://mozilla.github.io/pdf.js/) (Apache-2.0) and the Source Serif 4, IBM Plex Sans and IBM Plex Mono fonts (SIL Open Font License 1.1).
+
+<div align="center">
+<br>
+<sub>Built by Subham Divakar with ❤️ for people who read papers for a living.</sub>
+</div>