@railtownai/railtracks-visualizer 0.0.3 → 0.0.4

package/README.md

@@ -1,23 +1,52 @@
 # RailTracks Visualizer
 
-A React-based visualization tool for agentic flow data from the RailTracks framework.
+A React-based visualizer for RailTracks agentic flows
 
-## Features
+## 🚀 Quick Start
+
+### As an NPM Package
+
+1. **Install the package:**
+
+   ```bash
+   npm install @railtownai/railtracks-visualizer
+   ```
+
+2. **Import and use in your React app:**
+
+   ```tsx
+   import { Visualizer } from '@railtownai/railtracks-visualizer';
+
+   function App() {
+     const flowData = {
+       nodes: [...],
+       edges: [...],
+       stamps: [...]
+     };
+
+     return (
+       <Visualizer
+         flowData={flowData}
+         width="100%"
+         height="800px"
+       />
+     );
+   }
+   ```
+
+## 🎨 Features
 
 - **Interactive Flow Visualization**: Visualize agentic flows with nodes and edges
 - **Timeline Navigation**: Step through the flow execution timeline
-- **API Integration**: Load JSON files directly from the railtracks API server
-- **File Selector**: Dropdown with search functionality to select JSON files
-- **Node/Edge Inspection**: Click on elements to view detailed information
 - **Auto-layout**: Automatic positioning of nodes in a tree structure
 - **Responsive Design**: Works on different screen sizes
+- **Inspection Panel**: Detailed view of nodes and edges
+- **Playback Controls**: Play/pause timeline progression
 
-## Get Started
+## 📄 License
 
-1. Install it! `npm install --save @railtownai/railtracks-visualizer`
-2. Import the agent visualizer `<AgentVisualizer data={MY_RAILTRACKS_RUN_DATA} />`
-3. Render!
+Apache-2.0
 
-## License
+## 📞 Support
 
-This project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.
+For issues and questions, please open an issue on GitHub.