From ac07dd5053d79d16f6420de7f995e74e252a951e Mon Sep 17 00:00:00 2001 From: Jason McCollum Date: Wed, 15 May 2024 08:27:46 -0700 Subject: [PATCH] Update README --- README.md | 29 +++++++++++++---------------- 1 file changed, 13 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 399cb440..81dc2d99 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,23 @@ # Google Fleet Routing App -A web application to explore the capabilities of -the [**Cloud Fleet Routing**](https://cloud.google.com/optimization/docs/overview) (CFR) feature of -Google **Cloud Optimization API**. +A web application to explore the capabilities of [**Google Maps Platform Route Optimization**](https://developers.google.com/maps/documentation/route-optimization) (GMPRO). -CFR solves vehicle routing problems (VRPs). +GMPRO solves vehicle routing problems (VRPs). Given a set of *shipments* with locations, a set of *vehicles* to carry out deliveries, costs and additional constraints; -CFR works to find an optimal solution with efficient routes +GMPRO works to find an optimal solution with efficient routes where every shipment is delivered by a vehicle, with all constraints met and minimal cost. This application presents the properties -of the CFR data model as interactive forms, tables, and maps. +of the GMPRO data model as interactive forms, tables, and maps. Users may find it a helpful way to familiarize themselves with the data model and functions of the API. -Before writing any code, use the application to construct CFR scenarios, +Before writing any code, use the application to construct GMPRO scenarios, tune constraint parameters, visualize routes, and more. - + ![Fleet Routing App screenshot](application/frontend/src/assets/docs/app-overview.png) @@ -28,37 +26,36 @@ tune constraint parameters, visualize routes, and more. The application is intended to be used as an exploratory tool and should not be deployed in any production critical path. Google provides this application for users to try out the API and understand -how to model their use cases in CFR. +how to model their use cases in GMPRO. But customers should implement their own solutions -to integrate Cloud Fleet Routing into their business processes. +to integrate Route Optimization into their business processes. ## Billing The resources and API usage generated by the application are billed to the project owner. *Fleet Routing App is not free to use.* Customers can expect ongoing charges related to cloud resources (compute, networking, storage, etc.), -along with usage-based charges for the Maps Platform APIs and Cloud Fleet Routing. +along with usage-based charges for the Maps Platform APIs and Route Optimization. When running locally for development, -the application will still incur usage-based charges for Maps and CFR. +the application will still incur usage-based charges for Maps and GMPRO. In order to deploy the application to a project, the project must be linked to a valid **Google Cloud Billing Account**. The customer is responsible for all charges accrued on the account. -> ⚠️ The application and Cloud Fleet Routing perform several kinds of batch operations. +> ⚠️ The application and Route Optimization perform several kinds of batch operations. > This means it can be easy to generate a high volume of usage in a short period of time, > especially for large scenarios with many shipments. -> Familiarize yourself with the pricing models for Maps Platform and Cloud Fleet Routing +> Familiarize yourself with the pricing models for Maps Platform and Route Optimization > before using the application and routinely monitor the charges on your billing account. > > Keep scenarios small to begin with and get comfortable with the billing model > before attempting to solve large scenarios which may be expensive. ### Pricing -Refer to the following pricing guides for Cloud, Maps, and CFR for detailed costs: +Refer to the following pricing guides for Cloud, Maps, and GMPRO for detailed costs: - [Google Cloud Pricing](https://cloud.google.com/pricing) - [Google Maps Platform Pricing](https://mapsplatform.google.com/pricing/) -- [Cloud Fleet Routing Pricing](https://cloud.google.com/optimization/pricing) > ⚠️ Google Cloud and Google Maps Platform offer "getting started" and "free tier" credits that may cover > a small amount of usage for free. However, as mentioned in the previous section,