[update] enhanced ROADMAP.md
with advanced geographic tagging, hierarchical filtering, migration strategies, and expanded analytics features, clarified project phase details, and incorporated tagging upgrades into future plans
This commit is contained in:
63
README.md
63
README.md
@@ -6,11 +6,14 @@ Owly News Summariser is a modern web application that fetches news articles from
|
||||
|
||||
- Fetches news from configurable RSS feeds
|
||||
- Automatically summarizes articles using Ollama LLM
|
||||
- Filters news by country
|
||||
- **AI-powered intelligent tagging** with geographic, category, and source tags
|
||||
- **Advanced multi-criteria filtering** with hierarchical tag support
|
||||
- Progressive Web App (PWA) support for offline access
|
||||
- Scheduled background updates
|
||||
- High-performance Rust backend for optimal resource usage
|
||||
- Modern Vue.js frontend with TypeScript support
|
||||
- **Comprehensive analytics** and reading statistics
|
||||
- **Flexible sharing system** with multiple format options
|
||||
|
||||
## Project Structure
|
||||
|
||||
@@ -24,7 +27,7 @@ The project consists of multiple components:
|
||||
|
||||
### For Rust Backend (Recommended)
|
||||
- Rust 1.88.0+
|
||||
- [Ollama](https://ollama.ai/) for article summarization
|
||||
- [Ollama](https://ollama.ai/) for article summarization and tagging
|
||||
- SQLite (handled automatically by SQLx)
|
||||
|
||||
### For Python Backend (Legacy)
|
||||
@@ -102,6 +105,32 @@ The project consists of multiple components:
|
||||
|
||||
The frontend will be available at http://localhost:5173
|
||||
|
||||
## Key Features
|
||||
|
||||
### Intelligent Content Organization
|
||||
- **AI-Powered Tagging**: Automatic classification with geographic, topical, and source tags
|
||||
- **Hierarchical Filtering**: Multi-level filtering by location (country → region → city), categories, and content types
|
||||
- **Smart Search**: Advanced filtering with suggestions based on tag relationships and usage patterns
|
||||
- **Legacy Migration**: Seamless upgrade from simple country-based filtering to comprehensive tag-based system
|
||||
|
||||
### Advanced Analytics
|
||||
- **Reading Statistics**: Track reading time, completion rates, and engagement patterns
|
||||
- **Content Analytics**: Source performance, tag usage, and trending topics analysis
|
||||
- **Geographic Insights**: Location-based content distribution and reading preferences
|
||||
- **Goal Tracking**: Personal reading goals with progress monitoring
|
||||
|
||||
### Flexible Article Display
|
||||
- **Compact View**: Title, excerpt, tags, and action buttons for quick browsing
|
||||
- **On-Demand Loading**: Full content, AI summaries, and source links as needed
|
||||
- **Visual Tag System**: Color-coded, hierarchical tags with click-to-filter functionality
|
||||
- **Reading Status**: Visual indicators for read/unread status and progress tracking
|
||||
|
||||
### Enhanced Sharing
|
||||
- **Multiple Formats**: Text, Markdown, HTML, and JSON export options
|
||||
- **Custom Templates**: User-configurable sharing formats
|
||||
- **One-Click Operations**: Copy to clipboard with formatted content
|
||||
- **Privacy Controls**: Configurable information inclusion in shared content
|
||||
|
||||
## Building for Production
|
||||
|
||||
### Building the Rust Backend
|
||||
@@ -156,3 +185,33 @@ Run frontend tests:
|
||||
cd frontend
|
||||
npm run test
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
The application uses a comprehensive configuration system via `config.toml`:
|
||||
|
||||
- **AI Settings**: Configure Ollama integration for summaries and tagging
|
||||
- **Display Preferences**: Default views, themes, and UI customization
|
||||
- **Analytics**: Control data collection and retention policies
|
||||
- **Filtering**: Smart suggestions, saved filters, and geographic hierarchy
|
||||
- **Sharing**: Default formats and custom templates
|
||||
|
||||
See the example configuration in the project for detailed options.
|
||||
|
||||
## Migration from Legacy Systems
|
||||
|
||||
The application includes automatic migration tools for upgrading from simpler filtering systems:
|
||||
|
||||
- **Country Filter Migration**: Automatic conversion to hierarchical geographic tags
|
||||
- **Data Preservation**: Maintains historical data during migration
|
||||
- **Backward Compatibility**: Gradual transition with user control
|
||||
- **Validation Tools**: Ensure data integrity throughout the migration process
|
||||
|
||||
## Future Roadmap
|
||||
|
||||
The project is evolving through three phases:
|
||||
1. **Phase 1**: High-performance Rust backend with advanced filtering and analytics
|
||||
2. **Phase 2**: CLI application for power users and automation
|
||||
3. **Phase 3**: Migration to Dioxus for a full Rust stack
|
||||
|
||||
See `ROADMAP.md` for detailed development plans and architectural decisions.
|
||||
|
Reference in New Issue
Block a user