Skip to content

Commit 712806c

Browse files
committed
update docs
1 parent 19b320e commit 712806c

File tree

1 file changed

+93
-0
lines changed

1 file changed

+93
-0
lines changed

README.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,99 @@
33
> <:purple_heart: /> A Polymer element for show your love!.
44
55
[![Travis CI Status](https://travis-ci.org/simoneas02/made-with-love.svg?branch=master)](https://travis-ci.org/simoneas02/made-with-love)
6+
![bower](https://img.shields.io/bower/v/made-with-love.svg)
7+
8+
## How to install and use:
9+
10+
**0 -** install the basic dependencies
11+
12+
- [NodeJS](https://nodejs.org/en/)
13+
- [Bower](https://www.npmjs.com/package/bower)
14+
15+
**1 -** Install the element using [Bower](http://bower.io/):
16+
17+
```sh
18+
$ bower install made-with-love --save
19+
```
20+
21+
**2 -** Import the element:
22+
23+
```html
24+
<link rel="import" href="bower_components/made-with-love/made-with-love.html">
25+
```
26+
27+
**3 -** Start using it!
28+
29+
<!--
30+
```
31+
<custom-element-demo>
32+
<template>
33+
<link rel="import" href="made-with-love.html">
34+
<next-code-block></next-code-block>
35+
</template>
36+
</custom-element-demo>
37+
```
38+
-->
39+
```html
40+
<made-with-love href="https://simoneas02.github.io/">Simone Amorim</made-with-love>
41+
```
42+
43+
## Properties
44+
45+
Property | Type | Default | Description
46+
--- | --- | :---: | ---
47+
`href` | *String* | `#` | Hiper link reference
48+
49+
## Styling
50+
51+
The following custom properties and mixins are available for styling:
52+
53+
Custom property | Default | Description
54+
--- | --- | ---
55+
--made-with-love-color | #000 | Text color
56+
--made-with-love-text | {} | Text style
57+
--made-with-love-heart-color | #6309a0 | Heart color
58+
--made-with-love-heart-size | 10px | Heart size
59+
60+
## Browser Support
61+
62+
Using the [webcomponents.js](https://github.com/WebComponents/webcomponentsjs):
63+
64+
![IE](https://cloud.githubusercontent.com/assets/398893/3528325/20373e76-078e-11e4-8e3a-1cb86cf506f0.png) | ![Chrome](https://cloud.githubusercontent.com/assets/398893/3528328/23bc7bc4-078e-11e4-8752-ba2809bf5cce.png) | ![Firefox](https://cloud.githubusercontent.com/assets/398893/3528329/26283ab0-078e-11e4-84d4-db2cf1009953.png) | ![Opera](https://cloud.githubusercontent.com/assets/398893/3528330/27ec9fa8-078e-11e4-95cb-709fd11dac16.png) | ![Safari](https://cloud.githubusercontent.com/assets/398893/3528331/29df8618-078e-11e4-8e3e-ed8ac738693f.png)
65+
--- | --- | --- | --- | --- |
66+
11+ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔
67+
68+
## Development
69+
70+
**1 -** Install [Bower](http://bower.io/) & [Polymer-CLI](https://www.polymer-project.org/1.0/docs/tools/polymer-cli):
71+
72+
```sh
73+
$ [sudo] npm install -g bower polymer-cli
74+
```
75+
76+
**2 -** Install local dependencies:
77+
78+
```sh
79+
$ bower install
80+
```
81+
82+
**3 -** Start the development server:
83+
84+
```sh
85+
$ polyserve
86+
```
87+
88+
Go to [localhost:8080/components/made-with-love/](http://localhost:8080/components/made-with-love/)
89+
90+
## Tests
91+
92+
Linting with polylint:
93+
94+
```sh
95+
$ [sudo] npm install -g polylint
96+
97+
$ polylint
98+
```
699

7100
## Versioning
8101

0 commit comments

Comments
 (0)