From 88149396eb8cd91ea0a2ad196a7720f1a1bf44a6 Mon Sep 17 00:00:00 2001 From: Dan Nelson Date: Sun, 11 Nov 2018 22:19:14 -0700 Subject: [PATCH] #26 Cleanup the README --- README.md | 135 ++++++++--------------------------------------- config/deploy.js | 7 ++- 2 files changed, 28 insertions(+), 114 deletions(-) diff --git a/README.md b/README.md index e869251..be07cd0 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,9 @@ ![Dependencies](http://david-dm.org/cybertoothca/ember-cli-textarea-autosize.svg) [![ember-observer-badge](http://emberobserver.com/badges/ember-cli-textarea-autosize.svg)](http://emberobserver.com/addons/ember-cli-textarea-autosize) [![License](http://img.shields.io/npm/l/ember-cli-textarea-autosize.svg)](LICENSE.md) An Ember add-on that provides a textarea component that adjusts its -height according to the supplied text. Included are also several -mixins that can be used to ensure `autofocus` works properly, -focused text inputs have their text selected, and ctrl+enter will -submit the nearest form. +height according to the supplied text. Included is the Text Support +Mixins for autofocus, focus selects text, escape-pressed clears text, +and CTRL+ENTER submits `closest('form')`. This add-on installs from bower and uses the `autosize.js` library from Jack Moore: [https://github.com/jackmoore/autosize](https://github.com/jackmoore/autosize). @@ -29,9 +28,14 @@ from Jack Moore: [https://github.com/jackmoore/autosize](https://github.com/jack [![ember-beta](https://img.shields.io/badge/ember--try-ember--beta-brightgreen.svg)](https://circleci.com/gh/cybertoothca/ember-cli-text-support-mixins) [![ember-canary](https://img.shields.io/badge/ember--try-ember--canary-brightgreen.svg)](https://circleci.com/gh/cybertoothca/ember-cli-text-support-mixins) +## Demo & Documentation + +The demonstration web application can be found here: +[https://ember-cli-textarea-autosize.cybertooth.io/](https://ember-cli-textarea-autosize.cybertooth.io/). + ## Installation -Like most other Ember add-ons: +The following command will install this add-on: ``` ember install ember-cli-textarea-autosize @@ -57,118 +61,22 @@ The helper mixins from [`ember-cli-text-support-mixins`](http://ember-cli-text-s are used by this textarea add-on to include support for: * autofocus +* ESCAPE clears input text * CTRL+ENTER submits the closest form * textarea focus automatically selects text -## Demo - -The demonstration web application can be found here: -[http://ember-cli-textarea-autosize.cybertooth.io/](http://ember-cli-textarea-autosize.cybertooth.io/). - -## What Does This Add-on Do? - -This add-on gives you access to the following _component_: - -* `textarea-autosize` - an extension of the Ember.TextArea that -produces a `