Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vikdoro committed Jan 11, 2017
1 parent ae4ed9d commit 6305f03
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# Web Components

### A library of shared elements and behaviors in the Kano ecosystem
### A library of shared elements and behaviors for the Kano ecosystem

#### Development
----

After cloning the repo, install the dependencies in the main folder:

Expand All @@ -13,15 +12,15 @@ cd web-components
bower install
```

The components refer to their dependencies outside of their environment i.e. `../` and `../../`. This is because **web-components** is meant to be a bower dependency itself. Therefore, a good practice is using Polyserve [[link]](https://github.com/PolymerLabs/polyserve) that serves the component folders under `./bower_components/`.
The components refer to their bower dependencies outside of their environment i.e. `../` and `../../`. This is because **web-components** is meant to be a bower dependency itself.
E.g. `<link rel="import" href="../../iron-image/iron-image.html">` Therefore, a good practice is using Polyserve [[link]](https://github.com/PolymerLabs/polyserve) that serves the component folders under `./bower_components/`.

Polyserve's default port is **8080** and the components are accessible at `http://localhost:8080/components/web-components/{componentName}`.

For example, the `kano-auth` demo-page would be `http://localhost:8080/components/web-components/kano-auth/demo/index.html`.

To use the local version of **web-components** as a bower dependency, type ```bower link``` in the **web-components** folder and then ```bower link web-components``` in the project folder where you wish to use it.
To use the local version of **web-components** as a bower dependency, type ```bower link``` in the **web-components** folder and then ```bower link web-components``` in the project folder where you want to use it.

### Releasing on Github
----

When a new release is due, you can update the release in the Kano Web Components repository [[link]](https://github.com/KanoComputing/web-components/releases).

0 comments on commit 6305f03

Please sign in to comment.