Skip to content
This repository was archived by the owner on Feb 28, 2019. It is now read-only.

Commit 4e660b7

Browse files
committed
Add basic README
1 parent 1133be5 commit 4e660b7

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# React4j-Widget
2+
3+
[![Build Status](https://secure.travis-ci.org/react4j/react4j-widget.png?branch=master)](http://travis-ci.org/react4j/react4j-widget)
4+
[<img src="https://img.shields.io/maven-central/v/org.realityforge.react4j.widget/react4j-widget.svg?label=latest%20release"/>](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.realityforge.react4j.widget%22)
5+
[![codecov](https://codecov.io/gh/react4j/react4j-widget/branch/master/graph/badge.svg)](https://codecov.io/gh/react4j/react4j-widget)
6+
7+
This library provides a GWT widget that renders a React4j element.
8+
9+
## Quick Start
10+
11+
The simplest way to use component;
12+
13+
* add the following dependencies into the build system. i.e.
14+
15+
```xml
16+
<dependency>
17+
<groupId>org.realityforge.react4j.widget</groupId>
18+
<artifactId>react4j-widget</artifactId>
19+
<version>0.01</version>
20+
</dependency>
21+
```
22+
23+
* add the snippet `<inherits name="react4j.widget.ReactWidget"/>` into the .gwt.xml file.
24+
25+
* interact with the widget from within the browser.
26+
27+
```java
28+
RootLayoutPanel.get().add( new ReactWidget( h1( "Hello World" ) ) );
29+
```
30+
31+
# More Information
32+
33+
For more information about component, please see the [Website](https://react4j.github.io/react4j-widget). For the
34+
source code and project support please visit the [GitHub project](https://github.com/react4j/react4j-widget).
35+
36+
# Contributing
37+
38+
The component was released as open source so others could benefit from the project. We are thankful for any
39+
contributions from the community. A [Code of Conduct](CODE_OF_CONDUCT.md) has been put in place and
40+
a [Contributing](CONTRIBUTING.md) document is under development.
41+
42+
# License
43+
44+
The component is licensed under [Apache License, Version 2.0](LICENSE).

0 commit comments

Comments
 (0)