Skip to content

Commit 80cc166

Browse files
committed
Merge branch 'master' of github.com:Eoic/Papyrus
2 parents 7976691 + bd7540c commit 80cc166

File tree

1 file changed

+5
-17
lines changed

1 file changed

+5
-17
lines changed

README.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@
1717

1818
## Overview
1919

20-
Papyrus is an open-source, cross-platform application for managing and reading books. It supports both physical and digital book collections across Android, iOS, Web, Desktop, and e-ink devices. The application features an integrated e-book reader, flexible organization tools, progress tracking, various storage back-ends and cross-device synchronization via a self-hostable server.
20+
Papyrus is an open-source, cross-platform application for managing and reading books. It supports both physical and digital book collections across Android, iOS, Web, Windows and Linux. The application features an integrated book reader, flexible organization tools, reading statistics, progress tracking, supports various file storage back-ends and cross-device synchronization via a self-hostable server.
2121

2222
### Why Papyrus?
2323

24-
Many reading applications offer partial solutions but fall short on essential features or user experience. Papyrus aims to deliver a comprehensive, privacy oriented solution that:
24+
Many reading applications offer partial solutions but fall short on essential features, platform availability or user experience. Papyrus aims to deliver a comprehensive, privacy oriented solution that:
2525

26-
- Works offline-first with optional cloud sync
26+
- Works offline-first with optional cloud synchronization
2727
- Supports self-hosting for complete data ownership
28-
- Provides a unified experience across all platforms
28+
- Provides a unified experience across all popular platforms
2929
- Offers extensive customization for different reading preferences
3030

3131
## Features
@@ -38,7 +38,7 @@ Many reading applications offer partial solutions but fall short on essential fe
3838
| **Progress** | Reading time tracking, page/percentage progress, statistics |
3939
| **Goals** | Reading goals (books, pages, time) with streak tracking |
4040
| **Sync** | Cross-device synchronization via self-hostable server |
41-
| **Storage** | Multiple backends: Local, Google Drive, WebDAV, MinIO, S3 |
41+
| **Storage** | Multiple backends: Seff-hosted, Google Drive, WebDAV, MinIO, S3 |
4242
| **Accessibility** | E-ink optimization, dark/light themes, customizable fonts |
4343

4444
## Supported platforms
@@ -51,7 +51,6 @@ Many reading applications offer partial solutions but fall short on essential fe
5151
| Windows | Supported | Native desktop experience |
5252
| macOS | Supported | Requires Xcode for building |
5353
| Linux | Supported | AppImage/Snap distribution |
54-
| E-ink | Supported | Optimized UI for Boox, Kobo, etc. |
5554

5655
## Getting started
5756

@@ -123,15 +122,6 @@ mkdocs serve
123122
mkdocs build
124123
```
125124

126-
**Documentation includes:**
127-
128-
- [Market Analysis](spec/market-analysis.md) - Competitive landscape
129-
- [Functional Requirements](spec/requirements/functional-requirements.md) - System capabilities
130-
- [Use Cases](spec/use-cases.md) - Detailed workflows
131-
- [Database Model](spec/database-model.md) - Data architecture
132-
- [Server Architecture](spec/server-architecture.md) - Backend design
133-
- [Technologies](spec/technologies.md) - Tech stack details
134-
135125
## Technology stack
136126

137127
| Layer | Technology | Purpose |
@@ -144,8 +134,6 @@ mkdocs build
144134

145135
## Contributing
146136

147-
Contributions are welcome!
148-
149137
### Setup
150138

151139
1. Fork and clone the repository

0 commit comments

Comments
 (0)