From 809352dfb9391dd965ba8b549d4beff79fde9d20 Mon Sep 17 00:00:00 2001 From: Taylor Savage Date: Tue, 23 Feb 2016 17:01:17 -0800 Subject: [PATCH] tweaks to new README --- README.md | 34 +++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 140208a2c6..907d69429b 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,7 @@ [![Build Status](https://travis-ci.org/Polymer/polymer.svg?branch=master)](https://travis-ci.org/Polymer/polymer) -Polymer lets you build encapsulated, re-usable elements that work just like HTML elements, to use in building web applications. - -Polymer is a library built on top of Web Component, that makes it easier to build your very own custom HTML elements, which can be reused for any project. It makes building complex web applications easier and more efficient. Imagine you have a specific navigation bar or a hamburger menu that you like to create and use in all of your projects. Instead of building that navigation bar or menu for every project, you can utilize Polymer to easily create that element one time and then reuse it throughout your project or any project of your choosing. - -Polymer provides a declarative syntax (defining what needs to be done and letting the computer figure out how to do it), to easily create your own custom elements. It allows one to easily develop the structure of the element with HTML, style it with CSS, and add interactions with the element utilizing JavaScript. It also provides two-way data-binding meaning: - -1. When properties in the model gets updated, so does the user interface. -2. When the elements on the user interface get updated, the changes are propagated back to the model. - -If you don’t want to build your own custom elements Polymer comes with a collection of pre-built elements that you can just drop on a page and use immediately. You can even use Polymer's collection of elements as a starting point for you own elements. Just include it in a project, expand upon it customizing the element to your liking, thus creating your own custom element. - - +Polymer lets you build encapsulated, re-usable elements that work just like standard HTML elements, to use in building web applications. ```html @@ -26,15 +15,30 @@ If you don’t want to build your own custom elements Polymer comes with a colle ``` -## Getting Started - Check out [polymer-project.org](https://www.polymer-project.org) for all of the library documentation, including getting started guides, tutorials, developer reference, and more. Or if you'd just like to download the library, check out our [releases page](https://github.com/polymer/polymer/releases). +## Overview + +Polymer is a lightweight library built on top of the web standards-based [Web Components](http://webcomponents.org/) API's, and makes it easier to build your very own custom HTML elements. Creating re-usable custom elements - and using elements built by others - can make building complex web applications easier and more efficient. By being based on the Web Components API's built in the browser (or [polyfilled](https://github.com/webcomponents/webcomponentsjs) where needed), Polymer elements are interoperable at the browser level, and can be used with other frameworks or libraries that work with modern browsers. + +Among many ways to leverage custom elements, they can be particularly useful for building re-usable UI components. Instead of continually re-building a specific navigation bar or button in different frameworks and for different projects, you can define this element once using Polymer, and then reuse it throughout your project or in any future project. + +Polymer provides a declarative syntax to easily create your own custom elements, using all standard web technologies - define the structure of the element with HTML, style it with CSS, and add interactions to the element with JavaScript. + +Polymer also provides optional two-way data-binding, meaning: + +1. When properties in the model for an element get updated, the element can update itself in response. +2. When the element is updated internally, the changes can be propagated back to the model. + +Polymer is designed to be flexible, lightweight, and close to the web platform - the library doesn't invent complex new abstractions and magic, but uses the best features of the web platform in straightforward ways to simply sugar the creation of custom elements. + +In addition to the Polymer library for building your own custom elements, the Polymer project includes a collection of [pre-built elements](https://elements.polymer-project.org) that you can drop on a page and use immediately, or use as starting points for your own custom elements. + ## Polymer in 1 Minute -The Polymer library is a lightweight sugaring layer on top of the [web components](http://webcomponents.org/) API's to help in building your own web components. It adds convenient features to make it easy to build complex elements: +Polymer adds convenient features to make it easy to build complex elements: **Create and register a custom element**