@lunchflow/actual-flow 0.0.2 → 0.0.4

package/README.md

@@ -2,6 +2,10 @@
 
 A TypeScript tool that imports transactions from Lunch Flow to Actual Budget with an intuitive terminal UI for configuration and account mapping.
 
+## Demo
+
+[![asciicast](https://asciinema.org/a/gGd65kHnllxQNIk7umbonU324.svg)](https://asciinema.org/a/gGd65kHnllxQNIk7umbonU324)
+
 ## Features
 
 - 🔗 **Easy Setup**: Simple configuration process for both Lunch Flow and Actual Budget connections
@@ -14,35 +18,16 @@ A TypeScript tool that imports transactions from Lunch Flow to Actual Budget wit
 
 ## Installation
 
-### Prerequisites
-
-- Node.js 16+ 
-- TypeScript
-- Lunch Flow API access
-- Actual Budget instance
-
-### Quick Install
-
-```bash
-# Clone or download this repository
-git clone <repository-url>
-cd lunch-flow-actual-importer
+A simple command to install!
 
-# Install dependencies
-pnpm install
-
-# Build the project
-pnpm run build
-
-# Run the importer
-pnpm start
+```
+npx @lunchflow/actual-flow
 ```
 
-### Development Mode
+or using pnpm
 
-```bash
-# Run in development mode (no build required)
-pnpm run dev
+```
+pnpm dlx @lunchflow/actual-flow
 ```
 
 ## Configuration
@@ -82,114 +67,10 @@ When configuring account mappings, you'll see:
 
 ### Transaction Import
 
-1. Select a date range for import
-2. Review a preview of transactions to be imported
-3. Confirm the import
-4. Monitor progress with real-time feedback
-5. Automatic deduplication prevents importing existing transactions
-
-## API Requirements
-
-### Lunch Flow API
-
-The tool expects the following Lunch Flow API endpoints:
-
-- `GET /accounts` - List accounts
-- `GET /transactions` - List transactions with optional filters
-
-Expected response format:
-```json
-{
-  "accounts": [
-    {
-      "id": "account_id",
-      "name": "Account Name",
-      "type": "checking",
-      "balance": 1000.00,
-      "currency": "USD"
-    }
-  ]
-}
-```
-
-### Actual Budget API
-
-Uses the official `@actual-app/api` package for Actual Budget integration. The API works by:
-
-1. **Connecting to your Actual Budget server** - Downloads budget data to local cache
-2. **Using proper amount conversion** - Converts between decimal amounts (123.45) and integer format (12345) that Actual uses internally
-3. **Batch transaction import** - Uses `addTransactions` for efficient bulk imports
-4. **Local data caching** - Stores budget data in `./actual-data/` directory for faster access
-
-For more details, see the [Actual Budget API documentation](https://actualbudget.org/docs/api/).
-
-## Development
-
-### Project Structure
-
-```
-src/
-├── index.ts                 # Main entry point
-├── importer.ts             # Main importer class
-├── lunch-flow-client.ts    # Lunch Flow API client
-├── actual-budget-client.ts # Actual Budget API client
-├── transaction-mapper.ts   # Transaction mapping logic
-├── config-manager.ts       # Configuration management
-├── ui.ts                   # Terminal UI components
-└── types.ts                # TypeScript type definitions
-```
-
-### Building
-
-```bash
-# Development mode
-pnpm run dev
-
-# Build for production
-pnpm run build
-
-# Run built version
-pnpm start
-
-# Clean build artifacts
-pnpm run clean
-```
-
-## Troubleshooting
-
-### Common Issues
-
-1. **Connection Failed**: Verify your API credentials and network connectivity
-2. **No Accounts Found**: Ensure your Lunch Flow account has accounts and your Actual Budget budget is properly set up
-3. **Import Failed**: Check that account mappings are configured and transactions are within the selected date range
-
-### Debug Mode
-
-Run with debug logging:
-
-```bash
-DEBUG=* pnpm start
-```
-
-## Contributing
-
-1. Fork the repository
-2. Create a feature branch
-3. Make your changes
-4. Add tests if applicable
-5. Submit a pull request
-
-## License
-
-MIT License - see LICENSE file for details.
-
-## Support
-
-For issues and questions:
-
-1. Check the troubleshooting section
-2. Review the GitHub issues
-3. Create a new issue with detailed information
+1. Review a preview of transactions to be imported
+2. Confirm the import
+3. Monitor progress with real-time feedback
+4. Automatic deduplication prevents importing existing transactions
 
 ---