make readme easier to readme lol

README.md

@@ -1,20 +1,6 @@
-# StudSpider Status Dashboard
+# studspider-status
 
-A real-time inventory management dashboard that integrates with Square POS, Brickset.com, and a SQL database to track and visualize LEGO inventory changes.
+`studspider-status` is the frontend of `studspider`. An application used to track a square inventory and display changes over time, Brickset.com, and a SQL database to track and visualize LEGO inventory changes.
-
-## 📋 Overview
-
-StudSpider Status is a comprehensive dashboard application designed to monitor and track inventory discrepancies between Square's inventory system and actual stock levels. The application provides real-time insights into inventory changes, theme distributions, and system statistics.
-
-## 🎯 Key Features
-
-- **Real-Time Inventory Tracking**: Monitor changes between Square inventory and database records
-- **Square Integration**: Direct integration with Square POS API for inventory management
-- **Brickset.com API**: Fetch LEGO set information and theme data
-- **SQL Database Backend**: Persistent storage for tracking historical inventory changes
-- **Visual Analytics**: Interactive charts and graphs showing inventory distribution by theme
-- **Change Log**: Detailed timeline of all inventory modifications (additions, updates, deletions)
-- **Statistics Dashboard**: Quick overview of total sets, themes, and recent changes
 
 ## 🛠️ Technology Stack
 
@@ -27,9 +13,7 @@ StudSpider Status is a comprehensive dashboard application designed to monitor a
 - **ApexCharts/Vuetify Charts**: Data visualization
 
 ### Backend Integration
-- **Square API**: Point of sale and inventory management
+- **Studspider**: Python
-- **Brickset API**: LEGO set database and information
-- **SQL Database**: Inventory change tracking and historical data
 
 ## 📦 Installation
 
@@ -37,7 +21,6 @@ StudSpider Status is a comprehensive dashboard application designed to monitor a
 - Node.js (v16 or higher)
 - pnpm (recommended) or npm
 - Access to Square API credentials
-- Brickset API key
 - SQL database connection
 
 ### Setup
@@ -56,9 +39,6 @@ pnpm install
 3. Configure environment variables:
 Create a `.env` file in the root directory:
 ```env
-VITE_SQUARE_API_KEY=your_square_api_key
-VITE_SQUARE_ACCESS_TOKEN=your_square_access_token
-VITE_BRICKSET_API_KEY=your_brickset_api_key
 VITE_DATABASE_URL=your_database_connection_string
 ```
 
@@ -102,28 +82,6 @@ pnpm lint
 - **Dashboard**: Main inventory overview
 - **Review**: Inventory review and reconciliation
 - **Statistics**: Detailed analytics and reporting
-- **Demo**: Component showcase and UI examples
-
-## 🔌 API Integration
-
-### Square API
-The application connects to Square's Inventory API to:
-- Fetch current inventory levels
-- Track inventory adjustments
-- Monitor stock changes in real-time
-
-### Brickset API
-Integration with Brickset.com provides:
-- LEGO set information and details
-- Theme categorization
-- Set metadata and specifications
-
-### Database
-SQL database stores:
-- Historical inventory snapshots
-- Change logs with timestamps
-- User actions and modifications
-- Theme and set relationships
 
 ## 📁 Project Structure
 
@@ -161,7 +119,6 @@ studspider-status/
 └── README.md           # This file
 ```
 
-## 🎨 Customization
 
 ### Adding New Pages
 1. Create a new `.vue` file in `src/pages/`
@@ -185,14 +142,6 @@ layout: default
 ### Modifying Themes
 Edit the color palette in component files or update Vuetify theme settings in `src/plugins/vuetify.js`.
 
-## 🔒 Security Notes
-
-- Never commit API keys or sensitive credentials
-- Use environment variables for all API configuration
-- Implement proper authentication for production deployments
-- Secure database connections with appropriate credentials
-
-## 🐛 Troubleshooting
 
 ### Development Server Won't Start
 ```bash
@@ -211,28 +160,7 @@ rm -rf .vite
 
 ## 📝 License
 
-[Add your license here]
+Mozilla Public License 2.0
-
-## 👥 Contributing
-
-Contributions are welcome! Please follow these steps:
-1. Fork the repository
-2. Create a feature branch
-3. Commit your changes
-4. Push to the branch
-5. Open a Pull Request
-
-## 🔮 Future Enhancements
-
-- [ ] Real-time WebSocket updates for inventory changes
-- [ ] Export reports to PDF/Excel
-- [ ] Advanced filtering and search capabilities
-- [ ] User authentication and role-based access
-- [ ] Email notifications for inventory discrepancies
-- [ ] Mobile app version
-- [ ] Automated inventory reconciliation
-- [ ] Barcode scanning integration
-- [ ] Multi-location inventory support
 
 ## 📧 Support