From 457cd84023f8ac3287ce86ce10b3305eae45417f Mon Sep 17 00:00:00 2001 From: Jouni Koivuviita Date: Tue, 29 Sep 2015 11:50:02 +0300 Subject: Update README.md Fix resource paths and promote minified web components lite. --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c57595a..639a4a3 100644 --- a/README.md +++ b/README.md @@ -76,19 +76,19 @@ We offer three ways to use Vaadin Components in your project: Bower, CDN and ZIP - + - - + + - - + -- cgit v1.2.3 From b7e73dff1e15826e8f1862db186b1e84c3e575f8 Mon Sep 17 00:00:00 2001 From: Jouni Koivuviita Date: Tue, 29 Sep 2015 12:01:16 +0300 Subject: Update README.md Remove note about using the master branch for development snapshots, since there is no plan to keep the master referring to the master branches of each individual component. The master will always reflect the latest stable version. Clarify CDN instructions. --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 639a4a3..5632f59 100644 --- a/README.md +++ b/README.md @@ -44,19 +44,19 @@ We offer three ways to use Vaadin Components in your project: Bower, CDN and ZIP This will download Vaadin Components and its dependencies to the `bower_components` folder inside your project's folder. - If you want to experiment with current development code, download the snapshot version running: - - ```shell - $ bower install --save vaadin-components#master - ``` - - ##### CDN You can use Vaadin Components from CDN (see example below). This is especially convenient for services like JSFiddle, Codepen.io, etc. +For example, to import vaadin-grid, use the following URL: + `https://cdn.vaadin.com/vaadin-components/latest/vaadin-grid/vaadin-grid.html` - _*Note*: that we have a fragment in the url with the version to use, so you could for instance replace it with the snapshot version_ +To import all Vaadin Components, use the following URL: + + `https://cdn.vaadin.com/vaadin-components/latest/vaadin-components/vaadin-components.html` + + > You can also use the nightly snapshot versions of any component, e.g. https://cdn.vaadin.com/vaadin-components/master/vaadin-grid/vaadin-grid.html - ##### Download ZIP @@ -68,7 +68,7 @@ We offer three ways to use Vaadin Components in your project: Bower, CDN and ZIP Create a new HTML file inside your project folder and copy the following code into it (choose one of the options how to import Vaadin Components in the `` section): - > **Note on serving the files during development**, when using Bower or the ZIP archive: + > **Serving the files during development**, when using Bower or the ZIP archive: > Due to browser security restrictions, serving HTML imports from a `file:///` URL does not work. You need a web server to view pages where you use custom elements. One simple option is to use the [`serve`](https://www.npmjs.com/package/serve) NPM package. -- cgit v1.2.3 From f8301f1e9d4ceeaf2e2fd4ce2d87fee2418fbd83 Mon Sep 17 00:00:00 2001 From: Jouni Koivuviita Date: Tue, 29 Sep 2015 12:02:21 +0300 Subject: Update README.md Fix formatting regression --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5632f59..be71238 100644 --- a/README.md +++ b/README.md @@ -48,11 +48,11 @@ We offer three ways to use Vaadin Components in your project: Bower, CDN and ZIP You can use Vaadin Components from CDN (see example below). This is especially convenient for services like JSFiddle, Codepen.io, etc. -For example, to import vaadin-grid, use the following URL: + For example, to import vaadin-grid, use the following URL: `https://cdn.vaadin.com/vaadin-components/latest/vaadin-grid/vaadin-grid.html` -To import all Vaadin Components, use the following URL: + To import all Vaadin Components, use the following URL: `https://cdn.vaadin.com/vaadin-components/latest/vaadin-components/vaadin-components.html` -- cgit v1.2.3 From fef191e55a0055ace031fb2431fc2d9edc781052 Mon Sep 17 00:00:00 2001 From: Jouni Koivuviita Date: Tue, 29 Sep 2015 12:06:02 +0300 Subject: Update README.md Added instructions how to use a development snapshot version of individual components. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index be71238..078ffb1 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,12 @@ We offer three ways to use Vaadin Components in your project: Bower, CDN and ZIP ``` This will download Vaadin Components and its dependencies to the `bower_components` folder inside your project's folder. + + If you wish to use the development snapshot version of some component, you can install/update that separately: + + ```shell + $ bower install --save vaadin-grid#master + ``` - ##### CDN -- cgit v1.2.3