Files
simple-notes-sync/README.md

73 lines
1.8 KiB
Markdown

# Simple Notes Sync 📝
> Minimalistische Offline-Notizen mit Auto-Sync zu deinem eigenen Server
[![Android](https://img.shields.io/badge/Android-8.0%2B-green.svg)](https://www.android.com/)
[![Material Design 3](https://img.shields.io/badge/Material-Design%203-green.svg)](https://m3.material.io/)
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
**📱 [APK Download](https://github.com/inventory69/simple-notes-sync/releases/latest)** · **📖 [Dokumentation](DOCS.md)** · **🚀 [Quick Start](QUICKSTART.md)**
**🌍 Sprachen:** **Deutsch** · [English](README.en.md)
---
## Features
- 📝 Offline-First - Notizen immer verfügbar
- 🔄 Auto-Sync - Konfigurierbare Intervalle (15/30/60 Min)
- 🏠 Self-Hosted - WebDAV auf deinem Server
- 🔐 Privacy-First - Keine Cloud, kein Tracking
- 🔋 Akkuschonend - ~0.2-0.8% pro Tag
---
## 🚀 Quick Start
### 1. Server Setup
```bash
cd server
cp .env.example .env
# Passwort in .env setzen
docker compose up -d
```
➡️ **Details:** [Server Setup Guide](server/README.md)
### 2. App Installation
1. [APK herunterladen](https://github.com/inventory69/simple-notes-sync/releases/latest)
2. Installieren & öffnen
3. ⚙️ Einstellungen → Server konfigurieren
4. Auto-Sync aktivieren
➡️ **Details:** [Vollständige Anleitung](QUICKSTART.md)
---
## 📚 Dokumentation
- **[Quick Start Guide](QUICKSTART.md)** - Schritt-für-Schritt Anleitung für Endbenutzer
- **[Server Setup](server/README.md)** - WebDAV Server konfigurieren
- **[Vollständige Docs](DOCS.md)** - Features, Troubleshooting, Build-Anleitung
---
## 🛠️ Entwicklung
```bash
cd android
./gradlew assembleStandardRelease
```
➡️ **Details:** [Build-Anleitung in DOCS.md](DOCS.md)
---
## 📄 Lizenz
MIT License - siehe [LICENSE](LICENSE)
**v1.1.0** · Gebaut mit Kotlin + Material Design 3