refactor: Update Readme with new features (#204)

Author: regeter

README.md

@@ -1,100 +1,92 @@
 # Fleet Debugger Tool
 
-A debugging tool for use with the stateful [Last Mile Fleet Solutions](https://developers.google.com/maps/documentation/transportation-logistics/last-mile-fleet-solution) and [On Demand Rides and
-Deliveries](https://developers.google.com/maps/documentation/transportation-logistics/on-demand-rides-deliveries-solution) solutions.   Fleet debugger does not yet directly support the [Google Navigation SDK](https://developers.google.com/maps/documentation/navigation-sdk?hl=en) users must integrate with the [Trip and Order Progress SDKs](https://developers.google.com/maps/documentation/transportation-logistics/on-demand-rides-deliveries-solution/trip-order-progress).
+A visualization and debugging tool for Google Maps Platform's Mobility Solutions, supporting [Scheduled tasks](https://developers.google.com/maps/documentation/mobility/fleet-engine/essentials/tasks-intro) and [On-demand trips](https://developers.google.com/maps/documentation/mobility/fleet-engine/essentials/trip-intro).
 
 ![Screenshot](docs/screenshots/fleetdebugger.png)
 
-## Disclaimer
+## Using the Demo Site(s)
+
+The fastest way to get started is using our GitHub hosted site \
+https://googlemaps.github.io/fleet-debugger/demos/multiple-trips
+
+We also have demo data for:
+- [GPS accuracy issues](https://googlemaps.github.io/fleet-debugger/demos/jump/)
+- [Scheduled task](https://googlemaps.github.io/fleet-debugger/demos/lmfs/)
+
+### Loading Your Data
+
+1. Export your Fleet Engine logs from Cloud Logging using this filter (customize as needed):
+```sql
+resource.type="fleetengine.googleapis.com/Fleet"
+AND (labels.vehicle_id="YOUR_VEHICLE_ID" OR
+     labels.trip_id=("TRIP_ID_1" "TRIP_ID_2"))
+AND timestamp >= "START_TIME" -- ISO 8601 format (YYYY-MM-DDTHH:MM:SS)
+AND timestamp <= "END_TIME" -- ISO 8601 format (YYYY-MM-DDTHH:MM:SS)
+AND (
+    logName:"logs/fleetengine.googleapis.com%2Fcreate_vehicle" OR
+    logName:"logs/fleetengine.googleapis.com%2Fupdate_vehicle" OR
+    logName:"logs/fleetengine.googleapis.com%2Fcreate_trip" OR
+    logName:"logs/fleetengine.googleapis.com%2Fupdate_trip"
+)
+```
 
-This is not an officially supported Google product
+2. Download the logs in JSON format and optionally zip them
+3. Import the JSON/ZIP file to Fleet Debugger
 
-## Demos
+> **Note**: All data processing happens client-side. Your logs remain in your browser's Local Storage and are not uploaded to Google/GitHub.
 
+### Key Features
 
-* [Demo with GPS accurracy issues](https://googlemaps.github.io/fleet-debugger/demos/jump/)
-* [Demo with multiple trips](https://googlemaps.github.io/fleet-debugger/demos/multiple-trips/)
-* [Demo with LMFS tasks](https://googlemaps.github.io/fleet-debugger/demos/lmfs/)
+- Filter & inspect log messages with customizable table views
+- View planned navigation routes with traffic conditions as experienced by drivers
+- [Replay vehicle movement](docs/ReplaceVehicleMovement.md)
+- See requested vs. actual pickup and dropoff points
+- View status changes (vehicle, trip, navigation)
+- Analyze GPS data (location, accuracy, heading)
+- Visualize multiple trips for one vehicle
+- View [GPS accuracy](docs/GPSAccuracy.md), [speed](docs/Speed.md), and [heading](docs/Heading.md)
+- Analyze [dwell times](docs/DwellTimes.md)
 
+> **Note**: Planned navigation routes and Pickup/DropOff points requires enablement of [Restricted Use Logs](https://developers.google.com/maps/documentation/mobility/operations/cloud-logging/setup#enable_restricted_use_logs)
 
-## Getting Started
+### Restoring Demo Data
+To restore the original demo data after overwriting it:
+1. Long press the "Dataset 1" button
+2. When prompted, do NOT upload a file
+3. Refresh the page
 
-### Dependencies
+## Running Your Own Server
 
-Download & install node
-Download & install gcloud
+### Development Setup
 
-### Setup authentication
+1. Install dependencies:
+   - [Node.js](https://nodejs.org/en/download)
 
-```
-gcloud config set project <your project id>
-gcloud auth login
-gcloud auth application-default login
-```
-
-### Populate ./node_modules directory
-
-```
+2. Install node modules:
+```bash
 npm install
 ```
 
-## Examples
-
-View historical data from my-vehicle-id via [Trip and Order Progress SDKs](https://developers.google.com/maps/documentation/transportation-logistics/on-demand-rides-deliveries-solution/trip-order-progress)
-
-```
-# Generate data files
-dune-buggy.js historical --apikey <your api key> --vehicle=my-vehicle-id
-# start UI (should open up browser to localhost:3000
+### Start development server
+```bash
 npm start
 ```
 
-Generate sharable artifact
+### Building and Deploying
 
-```
-# Generate data files
-dune-buggy.js historical --apikey <your api key> --vehicle=my-vehicle-id
-# build sharable, static artifact.  Any webserver should be able to host this.
+```bash
+# Generate static build
 npm run build
-tar -czf support-dump.tgz build
-```
-
-## Generating a support bundle
-
-See [Reporting Issues](docs/reporting-issues.md) for details on how to generate a
-support bundle that can be used when reporting bugs or other issues to google.
-
-## Key Features
-
-Filter & Inspect log messages
-
-Customize which fields are shown in table view
-
-View important status changes: vehicle status, trip status, navigation status
-
-View raw GPS information, including location, accuracy & heading
-
-### Comprehensive, Pre-built Visualizations
-* Visualize multiple trips for one vehicle
-* [Replay Vehicle Movement](docs/ReplaceVehicleMovement.md)
-* [GPS Accuracy](docs/GPSAccuracy.md)
-* [Vehicle Speed](docs/Speed.md)
-* [Vehicle Heading](docs/Heading.md)
-* [Dwell Times](docs/DwellTimes.md)
 
+# Deploy to firebase
+npm install -g firebase-tools
+firebase deploy --only hosting
+```
 
-### Extensibility
-   * Easily add aditional related data from cloud logging
+## Disclaimer
 
-# Running On Windows
+This is not an officially supported Google product.
 
-Fleet debugger has been verified to run on Windows 10 in the command shell.  git, node and gcloud
-need to be installed first.
+## Additional Resources
 
-Example
-```
-node dune-buggy.js historical --apikey <your api key> --vehicle=my-vehicle-id
-# address line ending format issues
-npm run format 
-npm start
-```
+- [Reporting Issues](docs/reporting-issues.md)