Skip to content

Commit eb77c62

Browse files
committed
Added basic information
1 parent 74b9209 commit eb77c62

File tree

1 file changed

+43
-3
lines changed

1 file changed

+43
-3
lines changed

Diff for: README.md

+43-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,44 @@
1-
dygraphs-gwt
2-
============
1+
## What is Dygraphs-GWT?
32

4-
GWT wrapper for dygraphs
3+
4+
Dygraphs-GWT is a wrapper for the [dygraphs][0] chart library.
5+
The wrapper makes it easy to use dygraphs in any GWT application by providing a
6+
type-safe abstraction of the dygraphs API.
7+
8+
## How do I use it?
9+
10+
TODO
11+
12+
13+
14+
## How do I install it?
15+
16+
If you're using Maven, you can add the following to your `<dependencies>`
17+
section:
18+
19+
```xml
20+
<dependency>
21+
<groupId>com.github.timeu.dygraphs-gwt</groupId>
22+
<artifactId>dygraphs-gwt</artifactId>
23+
<version>1.0.0</version>
24+
</dependency>
25+
```
26+
27+
You can also download the [jar][1] directly or check out the source using git
28+
from <https://github.com/timeu/dygraphs-gwt.git> and build it yourself. Once
29+
you've installed Dygraphs-GWT, be sure to inherit the module in your .gwt.xml
30+
file like this:
31+
32+
```xml
33+
<inherits name='com.github.timeu.Dygraphs'/>
34+
```
35+
36+
## Where can I learn more?
37+
38+
* For more details on the Dygraphs-GWT API, consult the [Javadoc][2].
39+
* Check out the [sample app][3] for a full example of using Dygraphs-GWT.
40+
41+
[0]: https://http://dygraphs.com/
42+
[1]: http://search.maven.org/remotecontent?filepath=com/github/timeu/dygraphs-gwt/dygraphs-gwt/1.0.0/dygraphs-gwt-1.0.0.jar
43+
[2]: http://timeu.github.io/dygraphs-gwt/javadoc/
44+
[3]: https://github.com/timeu/dygraphs-gwt/tree/master/dygraphs-gwt-sample/src/main/java/sample/client

0 commit comments

Comments
 (0)