d79a44491d
- Remove bold formatting for cleaner look - Shorten descriptions to essentials - Keep 5 main categories - More scannable and minimalist style
109 lines
2.7 KiB
Markdown
109 lines
2.7 KiB
Markdown
# Simple Notes Sync 📝
|
|
|
|
> Minimalist offline notes with auto-sync to your own server
|
|
|
|
[](https://www.android.com/)
|
|
[](https://m3.material.io/)
|
|
[](LICENSE)
|
|
|
|
**📱 [APK Download](https://github.com/inventory69/simple-notes-sync/releases/latest)** · **📖 [Documentation](DOCS.en.md)** · **🚀 [Quick Start](QUICKSTART.en.md)**
|
|
|
|
**🌍 Languages:** [Deutsch](README.md) · **English**
|
|
|
|
---
|
|
|
|
## 📱 Screenshots
|
|
|
|
<p align="center">
|
|
<img src="android/fastlane/metadata/android/de-DE/images/phoneScreenshots/1.jpg" width="250" alt="Notes list">
|
|
<img src="android/fastlane/metadata/android/de-DE/images/phoneScreenshots/2.jpg" width="250" alt="Edit note">
|
|
<img src="android/fastlane/metadata/android/de-DE/images/phoneScreenshots/3.jpg" width="250" alt="Settings">
|
|
</p>
|
|
|
|
---
|
|
|
|
## Features
|
|
|
|
### 📝 Notes
|
|
- Create and edit simple text notes
|
|
- Automatic save
|
|
- Swipe-to-delete with confirmation
|
|
|
|
### 🔄 Synchronization
|
|
- Auto-sync (15/30/60 min intervals)
|
|
- WiFi-based - Sync on home WiFi connection
|
|
- Server check (2s timeout) - No errors in foreign networks
|
|
- Conflict-free merging via timestamps
|
|
|
|
### 🏠 Self-Hosted & Privacy
|
|
- WebDAV server (Nextcloud, ownCloud, etc.)
|
|
- Your data stays with you - No tracking, no analytics
|
|
- 100% Open Source (MIT license)
|
|
|
|
### 🔋 Performance
|
|
- Battery-friendly (~0.2-0.8% per day)
|
|
- Doze Mode optimized
|
|
- Offline-first - All features work without internet
|
|
|
|
### 🎨 Material Design 3
|
|
- Dynamic Colors (Material You)
|
|
- Dark Mode
|
|
- Modern, intuitive UI
|
|
|
|
---
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### 1. Server Setup
|
|
|
|
```bash
|
|
cd server
|
|
cp .env.example .env
|
|
# Set password in .env
|
|
docker compose up -d
|
|
```
|
|
|
|
➡️ **Details:** [Server Setup Guide](server/README.en.md)
|
|
|
|
### 2. App Installation
|
|
|
|
1. [Download APK](https://github.com/inventory69/simple-notes-sync/releases/latest)
|
|
2. Install & open
|
|
3. ⚙️ Settings → Configure server
|
|
4. Enable auto-sync
|
|
|
|
➡️ **Details:** [Complete guide](QUICKSTART.en.md)
|
|
|
|
---
|
|
|
|
## 📚 Documentation
|
|
|
|
- **[Quick Start Guide](QUICKSTART.en.md)** - Step-by-step guide for end users
|
|
- **[Server Setup](server/README.en.md)** - Configure WebDAV server
|
|
- **[Complete Docs](DOCS.en.md)** - Features, troubleshooting, build instructions
|
|
|
|
---
|
|
|
|
## 🛠️ Development
|
|
|
|
```bash
|
|
cd android
|
|
./gradlew assembleStandardRelease
|
|
```
|
|
|
|
➡️ **Details:** [Build instructions in DOCS.en.md](DOCS.en.md)
|
|
|
|
---
|
|
|
|
## 🤝 Contributing
|
|
|
|
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
|
|
|
|
---
|
|
|
|
## 📄 License
|
|
|
|
MIT License - see [LICENSE](LICENSE)
|
|
|
|
**v1.1.1** · Built with Kotlin + Material Design 3
|