cf54f44377
Complete overhaul of all metadata and documentation for v1.8.1: F-Droid Critical: - Fix broken umlauts in de-DE/10.txt changelog (für, hinzugefügt, aufgeräumt) - Shorten de-DE/7.txt changelog for brevity - Remove trailing newline from en-US/title.txt Version & Accuracy: - Update README badges (Android 7.0+) and footer (v1.8.1) - Add widgets, sorting, parallel sync to highlights - Fix APK names in workflows (removed "universal") - Update cache action v3 → v4 in PR workflow - Fix CONTRIBUTING.md filename references - Update QUICKSTART guides (APK name, typo, Android version, docs links) Feature Documentation: - Update full_description.txt (both locales) - remove NEW/NEU labels, add v1.8.0+ features - Major FEATURES.md update - add Views & Layout, Widgets sections, updated tech stack - Add UPCOMING.md v1.7.0-1.8.1 as released sections - Update DOCS.md roadmap references and dates to Feb 2026 - Create missing en-US changelogs 1.txt, 2.txt Supplementary Fixes: - Update BACKUP.md - add encryption docs, fix cross-references - Add CHANGELOG.md reference links v1.2.1-v1.8.1 (15 missing) - Fix DEBUG_APK.md duplicate header - Rewrite fastlane/README.md with both locales and limits table - Create SELF_SIGNED_SSL.de.md (full German translation) Affects: 26 files across READMEs, docs/, fastlane/, workflows
156 lines
6.1 KiB
Markdown
156 lines
6.1 KiB
Markdown
<div align="center">
|
|
<img src="android/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png" alt="Logo" />
|
|
</div>
|
|
|
|
<h1 align="center">Simple Notes Sync</h1>
|
|
|
|
<h4 align="center">Clean, offline-first notes with intelligent sync - simplicity meets smart synchronization.</h4>
|
|
|
|
<div align="center">
|
|
|
|
[](https://www.android.com/)
|
|
[](https://kotlinlang.org/)
|
|
[](https://developer.android.com/compose/)
|
|
[](https://m3.material.io/)
|
|
[](LICENSE)
|
|
|
|
</div>
|
|
|
|
<div align="center">
|
|
|
|
<a href="https://apt.izzysoft.de/fdroid/index/apk/dev.dettmer.simplenotes">
|
|
<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png"
|
|
alt="Get it on IzzyOnDroid" align="center" height="80" /></a>
|
|
|
|
<a href="https://apps.obtainium.imranr.dev/redirect.html?r=obtainium://add/https://github.com/inventory69/simple-notes-sync">
|
|
<img src="https://github.com/ImranR98/Obtainium/blob/main/assets/graphics/badge_obtainium.png"
|
|
alt="Get it on Obtainium" align="center" height="54" />
|
|
</a>
|
|
|
|
<a href="https://f-droid.org/packages/dev.dettmer.simplenotes">
|
|
<img src="https://f-droid.org/badge/get-it-on.png"
|
|
alt="Get it on F-Droid" align="center" height="80" /></a>
|
|
|
|
</div>
|
|
|
|
<div align="center">
|
|
<strong>SHA-256 hash of the signing certificate:</strong><br />42:A1:C6:13:BB:C6:73:04:5A:F3:DC:81:91:BF:9C:B6:45:6E:E4:4C:7D:CE:40:C7:CF:B5:66:FA:CB:69:F1:6A
|
|
</div>
|
|
|
|
<div align="center">
|
|
|
|
<br />[📱 APK Download](https://github.com/inventory69/simple-notes-sync/releases/latest) · [📖 Documentation](docs/DOCS.md) · [🚀 Quick Start](QUICKSTART.md)<br />
|
|
**🌍** [Deutsch](README.de.md) · **English**
|
|
|
|
</div>
|
|
|
|
## 📱 Screenshots
|
|
|
|
<p align="center">
|
|
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/1.png" width="250" alt="Sync status">
|
|
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/2.png" width="250" alt="Edit note">
|
|
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/3.png" width="250" alt="Edit checklist">
|
|
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/4.png" width="250" alt="Settings">
|
|
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/5.png" width="250" alt="Server settings">
|
|
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/7.png" width="250" alt="Sync settings">
|
|
</p>
|
|
|
|
<div align="center">
|
|
|
|
📝 Offline-first • 🔄 Smart Sync • 🔒 Self-hosted • 🔋 Battery-friendly
|
|
|
|
</div>
|
|
|
|
## ✨ Highlights
|
|
|
|
- 📝 **Offline-first** - Works without internet
|
|
- 📊 **Flexible views** - Switch between list and grid layout
|
|
- ✅ **Checklists** - Tap-to-check, drag & drop
|
|
- 🔄 **Configurable sync triggers** - onSave, onResume, WiFi-connect, periodic (15/30/60 min), boot
|
|
- 📌 **Widgets** - Home screen quick-note and note list widgets
|
|
- 🔀 **Smart sorting** - By title, date modified, date created, color
|
|
- ⚡ **Parallel sync** - Downloads up to 5 notes simultaneously
|
|
- 🌍 **Multilingual** - English/German with language selector
|
|
- 🔒 **Self-hosted** - Your data stays with you (WebDAV)
|
|
- 💾 **Local backup** - Export/Import as JSON file (encryption available)
|
|
- 🖥️ **Desktop integration** - Markdown export for Obsidian, VS Code, Typora
|
|
- 🎨 **Material Design 3** - Dynamic dark/light mode & colors based on system settings
|
|
|
|
➡️ **Complete feature list:** [FEATURES.md](docs/FEATURES.md)
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### 1. Server Setup (5 minutes)
|
|
|
|
```bash
|
|
git clone https://github.com/inventory69/simple-notes-sync.git
|
|
cd simple-notes-sync/server
|
|
cp .env.example .env
|
|
# Set password in .env
|
|
docker compose up -d
|
|
```
|
|
|
|
➡️ **Details:** [Server Setup Guide](server/README.md)
|
|
|
|
### 2. App Installation (2 minutes)
|
|
|
|
1. [Download APK](https://github.com/inventory69/simple-notes-sync/releases/latest)
|
|
2. Install & open
|
|
3. ⚙️ Settings → Configure server:
|
|
- **URL:** `http://YOUR-SERVER-IP:8080/` _(base URL only!)_
|
|
- **User:** `noteuser`
|
|
- **Password:** _(from .env)_
|
|
- **WiFi:** _(your network name)_
|
|
4. **Test connection** → Enable auto-sync
|
|
5. Done! 🎉
|
|
|
|
➡️ **Detailed guide:** [QUICKSTART.md](QUICKSTART.md)
|
|
|
|
## 📚 Documentation
|
|
|
|
| Document | Content |
|
|
|----------|---------|
|
|
| **[QUICKSTART.md](QUICKSTART.md)** | Step-by-step installation |
|
|
| **[FEATURES.md](docs/FEATURES.md)** | Complete feature list |
|
|
| **[BACKUP.md](docs/BACKUP.md)** | Backup & restore guide |
|
|
| **[DESKTOP.md](docs/DESKTOP.md)** | Desktop integration (Markdown) |
|
|
| **[SELF_SIGNED_SSL.md](docs/SELF_SIGNED_SSL.md)** | Self-signed SSL certificate setup |
|
|
| **[DOCS.md](docs/DOCS.md)** | Technical details & troubleshooting |
|
|
| **[CHANGELOG.md](CHANGELOG.md)** | Version history |
|
|
| **[UPCOMING.md](docs/UPCOMING.md)** | Upcoming features 🚀 |
|
|
| **[TRANSLATING.md](docs/TRANSLATING.md)** | Translation guide 🌍 |
|
|
|
|
```bash
|
|
cd android
|
|
./gradlew assembleStandardRelease
|
|
```
|
|
|
|
➡️ **Build guide:** [DOCS.md](docs/DOCS.md#-build--deployment)
|
|
|
|
## 💡 Feature Requests & Ideas
|
|
|
|
Have an idea for a new feature or improvement? We'd love to hear it!
|
|
|
|
➡️ **How to suggest features:**
|
|
|
|
1. Check [existing discussions](https://github.com/inventory69/simple-notes-sync/discussions) to see if someone already suggested it
|
|
2. If not, start a new discussion in the "Feature Requests / Ideas" category
|
|
3. Upvote (👍) features you'd like to see
|
|
|
|
Features with enough community support will be considered for implementation. Please keep in mind that this app is designed to stay simple and user-friendly.
|
|
|
|
## 🤝 Contributing
|
|
|
|
Contributions welcome! See [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
|
|
## 📄 License
|
|
|
|
MIT License - see [LICENSE](LICENSE)
|
|
|
|
<div align="center">
|
|
<br /><br />
|
|
|
|
**v1.8.1** · Built with ❤️ using Kotlin + Jetpack Compose + Material Design 3
|
|
|
|
</div>
|