diff --git a/README.md b/README.md index b027c50..ff497c4 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,46 @@ # Grocery Receipt Tracker -A database application to track your grocery receipts and compare prices between stores and over time. +A database application to track your grocery receipts (PDF/email format) and monitor price evolution over time. ## Overview This project helps you: -- Record and store your grocery receipts -- Track item prices across different stores -- Analyze price trends over time -- Compare costs to find the best deals +- Import and store your grocery receipts from email attachments or PDF files +- Extract item details and prices from receipt images/PDFs +- Track price changes for the same items across different stores and over time +- Analyze spending patterns and identify price trends +- Compare costs to find the best deals and optimize your shopping habits ## Features -- Store receipt details (date, store, items, prices) +- Import receipts from email attachments or PDF files +- Extract item details and prices using OCR technology +- Store receipt details (date, store, items, prices, total) +- Track price evolution for the same items over time - Compare prices for the same items across different stores -- Visualize price changes over time -- Identify cost-saving shopping patterns +- Visualize price changes with charts and graphs +- Generate reports on spending patterns and savings opportunities ## Getting Started -[Add instructions here for installation and setup] +1. Clone this repository +2. Install dependencies: `pip install -r requirements.txt` +3. Set up the database: `python manage.py migrate` +4. Start the application: `python manage.py runserver` +5. Import your first receipt by uploading a PDF or forwarding an email receipt ## Usage -[Add usage instructions here] +- Upload your grocery receipts (PDF or email attachments) +- The system will extract item details and prices using OCR +- View your receipt history and price tracking dashboard +- Use the comparison tools to analyze price changes over time +- Export reports for analysis or sharing ## Contributing -[Add contribution guidelines here] +We welcome contributions! Please read our contributing guidelines before submitting pull requests. ## License -[Add license information here] +This project is licensed under the MIT License - see the LICENSE file for details.