diff --git a/README.md b/README.md index db3d369..8e4d746 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,36 @@ This sample demonstrates how to obtain the coordinates for markers and navigation routes from the Google Maps Directions API and integrate them into the Syncfusion Maps to plot the route between designated locations. Add your key for the Google Maps Directions API to the **index.html** file located in the **quickstart** folder. + +## Project prerequisites +Make sure that you have the compatible versions of Visual Studio Code in your machine before starting to work on this project. +Ensure you have Node.js installed on your machine to run the project dependencies and scripts effectively. + +## How to run this application + +To run this application, you need to first clone the `how-to-create-a-route-between-the-markers-in-the-JavaScript-maps` repository and then navigate to its appropriate path where it has been located in your system. + +To do so, open the command prompt and run the below commands one after the other. + +``` +git clone https://github.com/SyncfusionExamples/how-to-create-a-route-between-the-markers-in-the-JavaScript-maps myproject +cd myproject +``` + +## Installing + +Once done with downloading, next you need to install the necessay packages required to run this application locally. The `npm install` command will install all the needed JS2 packages into your current project and to do so, run the below command. + +``` +npm install +``` + +## Running + +Finally, you can now use the below `npm` script to run the web application. + +``` +npm start +``` + +As this application is configured with `browser-sync`, therefore it will serve the web application directly in your default browser.