mirror of
https://github.com/bookorbit/bookorbit.git
synced 2026-11-03 00:11:37 -06:00
docs: polish README layout, badges, navigation, and section order
This commit is contained in:
neon
@@ -7,23 +7,32 @@
|
||||
|
||||
A self-hosted library and reading platform for ebooks, PDFs, audiobooks, and comics.
|
||||
|
||||
Copyright (C) 2025-2026 neon and BookOrbit contributors.
|
||||
|
||||
[](https://github.com/bookorbit/bookorbit/releases)
|
||||
[](https://github.com/bookorbit/bookorbit/stargazers)
|
||||
[](https://github.com/bookorbit/bookorbit/pkgs/container/bookorbit)
|
||||
[](https://github.com/bookorbit/bookorbit/actions/workflows/ci.yml)
|
||||
[](https://github.com/bookorbit/bookorbit/actions/workflows/release.yml)
|
||||
[](https://codecov.io/gh/bookorbit/bookorbit)
|
||||
[](https://crowdin.com/project/bookorbit)
|
||||
|
||||
[](https://bookorbit.app)
|
||||
[](https://demo.bookorbit.app/magic?token=2d92cb900e184cf0eb8b11f72cffc6011673d1016e1b300d750eb3d76abc1572)
|
||||
[](https://apps.apple.com/us/app/bookorbit-the-official-app/id6811807346)
|
||||
[](https://github.com/bookorbit/bookorbit/pkgs/container/bookorbit)
|
||||
[](https://crowdin.com/project/bookorbit)
|
||||
[](https://github.com/bookorbit/bookorbit/blob/main/docs/CONTRIBUTING.md)
|
||||
|
||||
|
||||
|
||||
<p align="center">
|
||||
<a href="#what-is-bookorbit">Overview</a> •
|
||||
<a href="#live-demo">Live Demo</a> •
|
||||
<a href="#bookorbit-for-iphone-and-apple-watch">iOS & Apple Watch</a> •
|
||||
<a href="#features">Features</a> •
|
||||
<a href="#quick-start-docker">Quick Start</a> •
|
||||
<a href="#managed-hosting">Managed Hosting</a> •
|
||||
<a href="#koreader-plugin">KOReader</a> •
|
||||
<a href="#documentation-and-contributing">Docs</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
@@ -36,6 +45,14 @@ Around that core sit 14 metadata providers, reading statistics and achievements,
|
||||
|
||||
[](https://bookorbit.app)
|
||||
|
||||
## Live Demo
|
||||
|
||||
Try the live instance before you install. No account required.
|
||||
|
||||
[](https://demo.bookorbit.app/magic?token=2d92cb900e184cf0eb8b11f72cffc6011673d1016e1b300d750eb3d76abc1572)
|
||||
|
||||
> **Note:** The demo includes a sample library of public domain books. Some administrative features are limited in the public demo. Self-hosting BookOrbit provides the full experience.
|
||||
|
||||
## BookOrbit for iPhone and Apple Watch
|
||||
|
||||
Take your library anywhere with the official native BookOrbit app. Read ebooks, PDFs, and comics; stream or download audiobooks; use text to speech; and keep reading offline. The app connects directly to your self-hosted BookOrbit server, while Apple Watch brings downloaded audiobooks and synchronized playback progress to your wrist.
|
||||
@@ -63,14 +80,6 @@ Take your library anywhere with the official native BookOrbit app. Read ebooks,
|
||||
|
||||
</details>
|
||||
|
||||
## Live Demo
|
||||
|
||||
Try the live instance before you install. No account required.
|
||||
|
||||
[](https://demo.bookorbit.app/magic?token=2d92cb900e184cf0eb8b11f72cffc6011673d1016e1b300d750eb3d76abc1572)
|
||||
|
||||
> **Note:** The demo includes a sample library of public domain books. Some administrative features are limited in the public demo. Self-hosting BookOrbit provides the full experience.
|
||||
|
||||
## Features
|
||||
|
||||
### Reading Experience & Sync
|
||||
@@ -128,11 +137,15 @@ Open `http://your-server-ip:3000` and complete setup using your `SETUP_BOOTSTRAP
|
||||
|
||||
For the full installation guide including reverse proxy setup, file permissions on NAS, secrets from mounted files, external databases, OIDC hardening, and environment variable reference, see **[bookorbit.app/installation](https://bookorbit.app/installation)**.
|
||||
|
||||
## Managed Hosting
|
||||
|
||||
Prefer a hosted instance without managing Docker or servers? [Zenith offers BookOrbit hosting](https://zenith.hosting/host/bookorbit) with a web file browser for uploads, access controls, and resource usage insights.
|
||||
|
||||
[](https://zenith.hosting/host/bookorbit)
|
||||
|
||||
## How I Actually Use BookOrbit
|
||||
|
||||
One read-along EPUB3 per book: listened to on iPhone, carried offline to Apple Watch for runs, read
|
||||
on a Kobo through KOReader, and picked up again on the laptop. One file, one reading position, no
|
||||
reconciling an audiobook against an ebook.
|
||||
One read-along EPUB3 per book: listened to on iPhone, carried offline to Apple Watch for runs, read on a Kobo through KOReader, and picked up again on the laptop. One file, one reading position, no reconciling an audiobook against an ebook.
|
||||
|
||||
Read the full walkthrough at **[bookorbit.app/my-workflow](https://bookorbit.app/my-workflow)**.
|
||||
|
||||
@@ -158,12 +171,6 @@ For setting up book requests, see the [book requests guide](docs/BOOK_REQUESTS.m
|
||||
download clients, path mappings, automation, and the encryption key they all need.
|
||||
For local development, see [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md). To contribute, see [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for the full workflow: branch naming, test expectations, PR checklist, and commit format.
|
||||
|
||||
## Managed Hosting
|
||||
|
||||
Prefer a hosted instance? [Zenith offers BookOrbit hosting](https://zenith.hosting/host/bookorbit) with a web file browser for uploads, access controls, and resource usage insights.
|
||||
|
||||
[](https://zenith.hosting/host/bookorbit)
|
||||
|
||||
## Repository Activity
|
||||
|
||||
|
||||
@@ -190,6 +197,8 @@ When adding user-facing text in code, add the Vue I18n key only to `client/src/l
|
||||
|
||||
## License and Attribution
|
||||
|
||||
Copyright (C) 2025-2026 neon and BookOrbit contributors.
|
||||
|
||||
BookOrbit is licensed under the **[GNU Affero General Public License v3.0 only](LICENSE)**.
|
||||
|
||||
BookOrbit material whose copyright holders have authorized them is also subject to the **[BookOrbit Additional Terms](ADDITIONAL_TERMS.md)** under sections 7(b), 7(c), 7(d), and 7(e) of the GNU AGPL v3. See the **[Attribution and Legal Notice](NOTICE)** for the required attribution.
|
||||
|
||||
Reference in New Issue
Block a user