@@ -10,12 +10,38 @@ import TabItem from '@theme/TabItem';
1010
1111![ Dashboard] ( /img/robotdashboard.png )
1212
13- Key Features:
14- - Command-Line Interface: Provides options to upload runs, list runs, remove runs, and generate dashboards.
15- - Customization: Supports specifying custom database locations, dashboard filenames, and output tagging.
16- - Test Result Analysis: Parses Robot Framework output XML files and extracts key metrics.
17- - HTML Dashboard Generation: Creates an interactive dashboard with graphs and tables for detailed insights.
18- - Filtering and Sorting: Allows filtering by run, suite, test, keyword, and tags for precise analysis.
19- - Statistics & Trends: Displays pass/fail rates, durations, most failed tests, and failure messages.
20-
21- The tool supports Robot Framework 6.x and 7.x, ensuring compatibility with various output formats.
13+ ## 🔍 Key features:
14+ - Multi-run analysis: compare results from multiple runs and track trends over time.
15+ - Interactive dashboard pages: Overview, Dashboard, Compare, suite/test/keyword drilldowns.
16+ - Graphs & tables: pass/fail, duration, status, flaky tests, historical trends, most failed tests.
17+ - Filtering and sorting: run, suite, test, keyword, tags, metadata, date range, and status.
18+ - Comparison mode: side-by-side view of up to 4 runs with delta statistics.
19+ - Log linking: click from dashboard entries to Robot Framework logs (local and server setups).
20+ - Customization: config defaults, layout persistence, graph options, dashboard sections.
21+ - Storage/extendability: SQLite backend plus custom database class support (MySQL/custom).
22+ - Server mode: optional HTTP service that includes an admin page, an API and hosts the dashboard.
23+ - Listener integration: runtime updates via listener to keep dashboard updated after each run.
24+
25+ ## 🚀 Install:
26+ ``` bash
27+ pip install robotframework-dashboard
28+ # for server/listener features
29+ pip install robotframework-dashboard[server]
30+ # or
31+ pip install robotframework-dashboard[all]
32+ ```
33+
34+ ## 📖 Quick links:
35+ - [ Working Example Dashboard] ( https://marketsquare.github.io/robotframework-dashboard/example/robot_dashboard.html )
36+ - [ Documentation] ( https://marketsquare.github.io/robotframework-dashboard/ )
37+ - [ PyPi] ( https://pypi.org/project/robotframework-dashboard/ )
38+ - [ GitHub] ( https://github.com/marketsquare/robotframework-dashboard )
39+
40+ ## 🎬 RoboCon Talk
41+ See also my 2025 [ RoboCon] ( https://robocon.io ) talk, where I explain robotdashboard and its use cases. Note that the UI has improved significantly since then.
42+
43+ [ ![ Robocon 2025 talk] ( https://img.youtube.com/vi/olf1_pd9YfM/0.jpg )] ( https://www.youtube.com/watch?v=olf1_pd9YfM )
44+
45+ ## 📋 Version requirements:
46+ - Robot Framework 6.0+
47+ - Python 3.8+
0 commit comments