diff --git a/README.md b/README.md index 723c633..aab5e29 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ # ej2-angular-tree-map -This example demonstrates the usage of Angular TreeMap Component in Angular 11 application. +This example demonstrates how to use the Angular TreeMap component within an Angular 11 application. The TreeMap component is a powerful data visualization tool that displays hierarchical data as a set of nested rectangles. Each rectangle represents a data node, and its size and color can be customized based on specific values, making it ideal for visualizing large datasets in a compact and intuitive manner. + +Documentation: https://ej2.syncfusion.com/angular/documentation/treemap/getting-started + +## Project pre-requisites +Make sure that you have the compatible versions of TypeScript and Angular in your machine before starting to work on this project: +* Angular 4+ +* TypeScript 2.6+ + +## How to run this application +To run this application, you need to first clone the `ej2-angular-tree-map` repository and then navigate to the path where it has been stored 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/ej2-angular-tree-map +treegrid-example +cd treegrid-example +``` + +## Installation +Once done with downloading, you need to install the packages required to run this application locally. To do so, run the following command: + +``` +npm install +``` +This will install all the needed Angular packages into your current project. + +## Running on a development server +Run the `ng serve` command for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. + +## Further help + +To get more help with the Angular CLI, use `ng help` or check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md). \ No newline at end of file