ReadKeep/README.md

56 lines
1.6 KiB
Markdown

# ReadKeep iOS App
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
A native iOS client for [readeck](https://readeck.org) bookmark management.
The official repository is on Codeberg:
https://codeberg.org/readeck/readeck
## Features
- Browse and manage bookmarks (All, Unread, Favorites, Archive, Article, Videos, Pictures)
- Share Extension for adding URLs from Safari and other apps
- Swipe actions for quick bookmark management
- Native iOS design with Dark Mode support
- Full iPad Support with Multi-Column Split View
- Font Customization
- Article View with Reading Time and Word Count
- Search functionality
## Configuration
After installing the app:
1. Open the readeck app
2. Enter your readeck server URL and credentials
3. The app will automatically load your bookmarks
## Share Extension
The app includes a Share Extension that allows adding bookmarks directly from Safari:
1. Share any webpage in Safari
2. Select "readeck" from the share sheet
3. Enter a title if you want and hit save
4. The bookmark is automatically added to your collection
## Planned Features
- [ ] Add support for bookmark filtering and sorting options
- [ ] Add support for tags
- [ ] Offline sync with Core Data
- [ ] Add support for collection management
- [ ] Add offline sync capabilities
- [ ] Add support for custom themes
## Contributing
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request