added readme

This commit is contained in:
Faris Ansari 2016-12-28 12:55:58 +05:30
parent cf3e4bbd8f
commit b32ac7d318

42
README.md Normal file
View File

@ -0,0 +1,42 @@
# Frappé Gantt
A simple, interactive, modern gantt chart library for the web
![image](https://cloud.githubusercontent.com/assets/9355208/19997551/5bc597f2-a28d-11e6-809a-4cfa5fdf96d2.png)
####View the demo [here](https://frappe.github.io/gantt).
###Install
```
npm install frappe-gantt
```
###Usage
Include it in your html:
```
<script src="frappe-gantt.js"></script>
```
And start hacking:
```
var gantt = new Gantt(
"#gantt",
[
{
start: "2016-10-04", end: "2016-10-10",
id: 0, name: "Explore ERPNext"
},
...
]
});
```
If you want to contribute:
1. Clone this repo.
2. `cd` into project directory
3. `npm install`
4. `npm run dev`
------------------
Project maintained by [frappe](https://github.com/frappe)