Update README
This commit is contained in:
31
README.md
31
README.md
@@ -4,14 +4,14 @@
|
|||||||
|
|
||||||
**A beautiful, distraction-free markdown reader for Windows**
|
**A beautiful, distraction-free markdown reader for Windows**
|
||||||
|
|
||||||
Premium editorial typography · Refined dark aesthetic · Fully portable
|
Built for everyone. Owned by no one. Free as in freedom.
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
<img src="https://img.shields.io/badge/version-1.0.0-6B8AFF?style=flat-square&labelColor=282C33" alt="Version">
|
<img src="https://img.shields.io/badge/version-1.0.0-6B8AFF?style=flat-square&labelColor=282C33" alt="Version">
|
||||||
<img src="https://img.shields.io/badge/platform-Windows-6B8AFF?style=flat-square&labelColor=282C33" alt="Platform">
|
<img src="https://img.shields.io/badge/platform-Windows-6B8AFF?style=flat-square&labelColor=282C33" alt="Platform">
|
||||||
<img src="https://img.shields.io/badge/Tauri-v2-6B8AFF?style=flat-square&labelColor=282C33" alt="Tauri">
|
<img src="https://img.shields.io/badge/Tauri-v2-6B8AFF?style=flat-square&labelColor=282C33" alt="Tauri">
|
||||||
<img src="https://img.shields.io/badge/license-CC0-6B8AFF?style=flat-square&labelColor=282C33" alt="License">
|
<img src="https://img.shields.io/badge/license-CC0_Public_Domain-6B8AFF?style=flat-square&labelColor=282C33" alt="License">
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@@ -19,7 +19,9 @@ Premium editorial typography · Refined dark aesthetic · Fully portable
|
|||||||
|
|
||||||
## 📖 Overview
|
## 📖 Overview
|
||||||
|
|
||||||
Vesper renders your markdown with carefully tuned typography and a refined dark interface, giving you the ultimate reading experience. No installation, no AppData, no registry - just drop the exe and go.
|
Vesper renders your markdown with carefully tuned typography and a refined dark interface, giving you the ultimate reading experience. No installation, no AppData, no registry, no telemetry, no accounts, no subscriptions - just drop the exe and go.
|
||||||
|
|
||||||
|
Knowledge should be accessible to all. Vesper exists to make reading a pleasure, not a product.
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
@@ -35,7 +37,7 @@ Full CommonMark support via **markdown-it** with extensions:
|
|||||||
| ☑️ Task Lists | Interactive checkboxes in lists |
|
| ☑️ Task Lists | Interactive checkboxes in lists |
|
||||||
| ᴬᵇ Superscript / Subscript | `^text^` and `~text~` notation |
|
| ᴬᵇ Superscript / Subscript | `^text^` and `~text~` notation |
|
||||||
| 🖍️ Highlight | `==marked text==` rendered with accent background |
|
| 🖍️ Highlight | `==marked text==` rendered with accent background |
|
||||||
| 💬 Typographer | Smart quotes, em-dashes, and ellipses |
|
| 💬 Typographer | Smart quotes, dashes, and ellipses |
|
||||||
| 🔗 Linkify | Bare URLs auto-converted to clickable links |
|
| 🔗 Linkify | Bare URLs auto-converted to clickable links |
|
||||||
| 📄 HTML | Inline HTML passthrough |
|
| 📄 HTML | Inline HTML passthrough |
|
||||||
| ↵ Breaks | Newlines preserved as line breaks |
|
| ↵ Breaks | Newlines preserved as line breaks |
|
||||||
@@ -133,10 +135,12 @@ Full CommonMark support via **markdown-it** with extensions:
|
|||||||
### Download
|
### Download
|
||||||
|
|
||||||
Download the latest **`vesper.exe`** from the [Releases](https://github.com/yourusername/vesper/releases) page.
|
Download the latest **`vesper.exe`** from the [Releases](https://github.com/yourusername/vesper/releases) page.
|
||||||
No installation required - Vesper is fully portable.
|
No installation required - Vesper is fully portable. No gatekeepers between you and your documents.
|
||||||
|
|
||||||
### Build from Source
|
### Build from Source
|
||||||
|
|
||||||
|
Everyone has the right to inspect, modify, and rebuild the tools they use.
|
||||||
|
|
||||||
> **Requires:** [Node.js](https://nodejs.org/) v18+ · [Rust](https://www.rust-lang.org/tools/install) stable · [Tauri v2 prerequisites](https://v2.tauri.app/start/prerequisites/)
|
> **Requires:** [Node.js](https://nodejs.org/) v18+ · [Rust](https://www.rust-lang.org/tools/install) stable · [Tauri v2 prerequisites](https://v2.tauri.app/start/prerequisites/)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -151,13 +155,15 @@ npm run tauri dev
|
|||||||
|
|
||||||
# Production build
|
# Production build
|
||||||
npm run tauri build
|
npm run tauri build
|
||||||
# → src-tauri/target/release/vesper.exe
|
# -> src-tauri/target/release/vesper.exe
|
||||||
```
|
```
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
## 🔧 Technology Stack
|
## 🔧 Technology Stack
|
||||||
|
|
||||||
|
Built entirely on open-source foundations - no proprietary dependencies, no vendor lock-in.
|
||||||
|
|
||||||
| | Layer | Technology |
|
| | Layer | Technology |
|
||||||
|:--|:--|:--|
|
|:--|:--|:--|
|
||||||
| ⚙️ | Runtime | [Tauri v2](https://tauri.app/) - Rust + WebView2 |
|
| ⚙️ | Runtime | [Tauri v2](https://tauri.app/) - Rust + WebView2 |
|
||||||
@@ -176,19 +182,19 @@ npm run tauri build
|
|||||||
|
|
||||||
## 💼 Portable
|
## 💼 Portable
|
||||||
|
|
||||||
Vesper is **fully portable** - zero installation, zero system footprint.
|
Vesper is **fully portable** - zero installation, zero system footprint. Your tools, your data, under your control.
|
||||||
|
|
||||||
All data lives in a `data/` folder next to the executable:
|
All data lives in a `data/` folder next to the executable:
|
||||||
|
|
||||||
```
|
```
|
||||||
vesper.exe
|
vesper.exe
|
||||||
data/
|
data/
|
||||||
├── window-state.json ← window position, size, maximized
|
├── window-state.json <- window position, size, maximized
|
||||||
└── EBWebView/ ← WebView2 data (localStorage, cache)
|
└── EBWebView/ <- WebView2 data (localStorage, cache)
|
||||||
```
|
```
|
||||||
|
|
||||||
> Nothing is written to AppData, the registry, or any other system location.
|
> Nothing is written to AppData, the registry, or any other system location.
|
||||||
> To move Vesper, just copy the exe and optionally the `data/` folder.
|
> No cloud sync, no phoning home. To move Vesper, just copy the exe and optionally the `data/` folder.
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
@@ -201,6 +207,7 @@ data/
|
|||||||
| 🌙 | **Dark by Default** - deep onyx base `#282C33` reduces eye strain |
|
| 🌙 | **Dark by Default** - deep onyx base `#282C33` reduces eye strain |
|
||||||
| ⌨️ | **Keyboard Driven** - every feature accessible via shortcuts |
|
| ⌨️ | **Keyboard Driven** - every feature accessible via shortcuts |
|
||||||
| ✨ | **Minimalist Chrome** - the interface gets out of your way |
|
| ✨ | **Minimalist Chrome** - the interface gets out of your way |
|
||||||
|
| 🤝 | **No Extraction** - no ads, no tracking, no data harvesting, no paywalls |
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
@@ -247,12 +254,14 @@ vesper/
|
|||||||
|
|
||||||
## 📜 License
|
## 📜 License
|
||||||
|
|
||||||
This project is dedicated to the public domain under **CC0 1.0 Universal** - see the [LICENSE](LICENSE) file for details.
|
Dedicated to the **public domain** under [CC0 1.0 Universal](LICENSE). No copyright, no restrictions, no permission needed. Take it, use it, change it, share it - it belongs to everyone.
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
## 🙏 Acknowledgments
|
## 🙏 Acknowledgments
|
||||||
|
|
||||||
|
Built with gratitude on the collective work of open-source communities worldwide:
|
||||||
|
|
||||||
- [iA Writer](https://ia.net/writer) - design inspiration
|
- [iA Writer](https://ia.net/writer) - design inspiration
|
||||||
- [Tauri](https://tauri.app/) - desktop framework
|
- [Tauri](https://tauri.app/) - desktop framework
|
||||||
- [markdown-it](https://github.com/markdown-it/markdown-it) - markdown parsing
|
- [markdown-it](https://github.com/markdown-it/markdown-it) - markdown parsing
|
||||||
|
|||||||
Reference in New Issue
Block a user