diff --git a/README.md b/README.md index 2bd8a0e..4cd7cee 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
- +

Frappe Gantt

**A modern, configurable, Gantt library for the web.** @@ -10,11 +10,9 @@
-
- Hero Image -
+![Hero Image](.github/hero_image.png) -## About +## Frappe Gantt Gantt charts are bar charts that visually illustrate a project's tasks, schedule, and dependencies. With Frappe Gantt, you can build beautiful, customizable, Gantt charts with ease. You can use it anywhere from hobby projects to tracking the goals of your team at the worksplace. @@ -22,17 +20,12 @@ You can use it anywhere from hobby projects to tracking the goals of your team a [ERPNext](https://erpnext.com/) uses Frappe Gantt. -## Motivation -We needed a Gantt View for a project, but surprisingly couldn't find a visually appealing Gantt library that was open source. So we built it! - -Initially, the design was heavily inspired by Google Gantt and DHTMLX. - -Today, we pride ourselves on having the most aesthetically pleasing _and_ powerful Gantt library on the market - except, of course, that it's free. +### Motivation +I needed a Gantt View for ERPNext. Surprisingly, I couldn't find a visually appealing Gantt library that was open source - so I decided to build it. Initially, the design was heavily inspired by Google Gantt and DHTMLX. -## Key Features -A wide variety of modes - be it day, hour, or year, you have it. Or add your own modes! -- **Customizable Views**: customize the timeline based on various time periods - day, hour, or year, you have it. And if it's not covered, you can create your own! +### Key Features +- **Customizable Views**: customize the timeline based on various time periods - day, hour, or year, you have it. You can also create your own views. - **Ignore Periods**: exclude weekends and other holidays from your tasks' progress calculation. - **Configure Anything**: spacing, edit access, labels, you can control it all. Change both the style and functionality to meet your needs. - **Multi-lingual Support**: suitable for companies with an international base. @@ -57,7 +50,7 @@ Or from the CDN: ``` -And start hacking: +Star using Gantt: ```js let tasks = [ { @@ -72,7 +65,8 @@ let tasks = [ let gantt = new Gantt("#gantt", tasks); ``` -To see the list of all options, check out [the docs](docs.frappe.io/gantt) (under development). + + ## Development Setup If you want to contribute enhancements or fixes: @@ -84,7 +78,8 @@ If you want to contribute enhancements or fixes: 5. Open `index.html` in your browser. 6. Make your code changes and test them. -

+
+