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

Commit 2cb9ede

Browse files
committed
Add minimal README
1 parent 423161c commit 2cb9ede

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# React4j-Widget
2+
3+
[![Build Status](https://secure.travis-ci.org/react4j/react4j-windowportal.png?branch=master)](http://travis-ci.org/react4j/react4j-windowportal)
4+
[<img src="https://img.shields.io/maven-central/v/org.realityforge.react4j.windowportal/react4j-windowportal.svg?label=latest%20release"/>](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.realityforge.react4j.windowportal%22)
5+
[![codecov](https://codecov.io/gh/react4j/react4j-windowportal/branch/master/graph/badge.svg)](https://codecov.io/gh/react4j/react4j-windowportal)
6+
7+
This library provides a portal that renders into a Window.
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.windowportal</groupId>
18+
<artifactId>react4j-windowportal</artifactId>
19+
<version>0.01</version>
20+
</dependency>
21+
```
22+
23+
* add the snippet `<inherits name="react4j.windowportal.WindowPortal"/>` into the .gwt.xml file.
24+
25+
* Use the WindowPortal as a react component.
26+
27+
# More Information
28+
29+
For more information about component, please see the [Website](https://react4j.github.io/react4j-windowportal). For the
30+
source code and project support please visit the [GitHub project](https://github.com/react4j/react4j-windowportal).
31+
32+
# Contributing
33+
34+
The component was released as open source so others could benefit from the project. We are thankful for any
35+
contributions from the community. A [Code of Conduct](CODE_OF_CONDUCT.md) has been put in place and
36+
a [Contributing](CONTRIBUTING.md) document is under development.
37+
38+
# License
39+
40+
The component is licensed under [Apache License, Version 2.0](LICENSE).

0 commit comments

Comments
 (0)