From 90c915d6b8ccc23677c04c653c63f11e1e3eb775 Mon Sep 17 00:00:00 2001 From: MeTaNoV Date: Sun, 13 Dec 2015 02:26:09 +0100 Subject: [PATCH] updated README.md --- README.md | 75 +++++++++++++++++++++---------------------------------- 1 file changed, 29 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 1553d07..748ca3f 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,46 @@ +[![Bower version](https://badge.fury.io/bo/identicon-element.svg)](https://badge.fury.io/bo/identicon-element) +[![Build Status](https://travis-ci.org/MeTaNoV/identicon-element.svg?branch=master)](https://travis-ci.org/MeTaNoV/identicon-element) +[![Dependency Status](https://gemnasium.com/MeTaNoV/identicon-element.svg)](https://gemnasium.com/MeTaNoV/identicon-element) - +Install the component using [Bower](http://bower.io/): +```sh +$ bower install identicon-element --save +``` -##<marked-element> +## Usage +Import Custom Element: -Element wrapper for the [marked](https://github.com/chjj/marked) library. +```html + +``` -`` accepts Markdown source, and renders it to a child -element with the class `markdown-html`. This child element can be styled -as you would a normal DOM element. If you do not provide a child element -with the `markdown-html` class, the Markdown source will still be rendered, -but to a shadow DOM child that cannot be styled. +And then use it: -The Markdown source can be specified either via the `markdown` attribute: +```html + +``` - -
-
+See the [Documentation](https://metanov.github.io/identicon-element/) for more options. -Or, you can provide it via a ` -
- -Note that the `