Skip to content

Commit bbda741

Browse files
committed
Improve a little docs
1 parent ddadce8 commit bbda741

File tree

2 files changed

+20
-9
lines changed

2 files changed

+20
-9
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,15 @@ We took this decision because once demonstrated that polymer elements could be e
3636

3737
## Using the GWT library
3838

39-
**NOTICE** : We make an extensive use of `JsInterop`, a new feature in `GWT` for easily interacting with JavaScript.
40-
It was experimental in `GWT-2.7`, and stable in `GWT-2.8.0`, but starting from gwt-polymer-elements-1.2.1.0.beta1, we don't support 2.7.0 anymore or it's legacy JsInterop syntax.
39+
You need at least GWT-2.8.0 to use the library.
4140

4241
### Add vaadin-gwt-polymer-elements to your CLASSPATH
4342
The `.jar` file includes all the java code and web components of
4443
Polymer Iron and Paper collections, so as you don't have to deal with the process of downloading and deploying all js wrapped libraries and components.
4544

4645
##### Using maven
4746

48-
- If your project uses maven add the dependency:
47+
- If your project uses maven add the following dependency to your `pom.xml`
4948

5049
```xml
5150
<dependencies>
@@ -187,6 +186,10 @@ In summary, for classic and production GWT projects it would be easier to use th
187186

188187
## Notes
189188

189+
### Java Sources
190+
If you want to dive into `.java` sources, we don't maintain generated files, thus you need to download the [vaadin-gwt-polymer-elements-x.x.x-sources.jar](http://repo1.maven.org/maven2/com/vaadin/polymer/vaadin-gwt-polymer-elements/) bundle.
191+
Otherwise you might take a look java helper classes and templates look in the [gwt-api-generator](https://github.com/manolo/gwt-api-generator) project.
192+
190193
### Importing Web Components
191194
Before using any component, you have to import the appropriate files. But `gwt-polymer-elements` comes with some utilities so as you it would be done automatically.
192195

@@ -212,9 +215,8 @@ In summary, for classic and production GWT projects it would be easier to use th
212215
```
213216

214217
### Asynchronous issues
215-
Polymer 1.x.x does not allow using custom properties before the web component has been initialized.
216-
Thus `gwt-polymer-elements` comes with some methods which helps to run callbacks when the component starts ready.
217-
If you use widgets, the library would be able to deal with properties set very early, but call to some methods could not work
218+
Web Components could be registered and initialised asynchronously. Thus `gwt-polymer-elements` comes with some methods which helps to run callbacks when the component is actually ready.
219+
218220

219221
```
220222
PaperButtonElement button = Polymer.createElement(PaperButtonElement.TAG);
@@ -242,6 +244,17 @@ In summary, for classic and production GWT projects it would be easier to use th
242244
})
243245
244246
```
247+
248+
### Using latest snapshot
249+
250+
Add the following repo to your `pom.xml`, and change the version using the latest listed at in [this url](https://oss.sonatype.org/content/repositories/snapshots/com/vaadin/polymer/vaadin-gwt-polymer-elements/)
251+
252+
<repository>
253+
<id>snapshots</id>
254+
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
255+
<snapshots><enabled>true</enabled></snapshots>
256+
</repository>
257+
245258

246259
## Contributors
247260

@@ -258,4 +271,4 @@ To compile the `vaadin-gwt-polymer-elements` library by yourself.
258271
1. To run and debug the demo, go to the demo folder `$ cd demo`
259272
1. Run `$ mvn gwt:devmode` to run the demo in SuperDevMode, otherwise run `$ mvn clean package` to
260273
build the demo application under `target` directory.
261-
1. Host the demo either: by running for example `$ serve target/gwt-polymer-demo` (requires [serve](https://npmjs.org/packages/serve)) or deploying the generated `target/gwt-polymer-demo.war` to your favourite servlet container.
274+
1. You can serve the demo directly from the `target/gwt-polymer-demo` or you can deploy the generated `target/gwt-polymer-demo.war` in a servlet container.

demo/pom.xml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,6 @@
5757
<artifactId>gwt-codeserver</artifactId>
5858
<scope>provided</scope>
5959
</dependency>
60-
61-
<!-- this is the dependency to the "jar"-subproject -->
6260
<dependency>
6361
<groupId>com.vaadin.polymer</groupId>
6462
<artifactId>vaadin-gwt-polymer-elements</artifactId>

0 commit comments

Comments
 (0)