Skip to content

Commit

Permalink
Reorganize README
Browse files Browse the repository at this point in the history
  • Loading branch information
astralarya committed Jun 24, 2016
1 parent 7475934 commit 448da27
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# react-console

Simple React.js console emulator.
See the [live demo](https://autochthe.github.io/react-console/).

[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][npm-url]
Expand All @@ -12,18 +11,6 @@ See the [live demo](https://autochthe.github.io/react-console/).
[![peerDependency Status][david-peer-image]][david-peer-url]


## Installation

npm install --save-dev react-console-component


## Features

* Readline emulation
* Mobile friendly
* Input Method Editor (IME) support


## Example

Simple prompt that echoes back input:
Expand All @@ -43,7 +30,19 @@ let EchoConsole = React.createClass({
});
```

See the [example project](example) used in the live demo.
See the [example project](example) used in the [live demo][demo-url].


## Installation

npm install --save-dev react-console-component


## Features

* Readline emulation
* Mobile friendly
* Input Method Editor (IME) support


## Props
Expand Down Expand Up @@ -74,7 +73,7 @@ Properties you can pass to the console element

React-console is inspired by [chrisdone/jquery-console](https://github.com/chrisdone/jquery-console).


[demo-url]: https://autochthe.github.io/react-console/
[npm-image]: https://img.shields.io/npm/v/react-console-component.svg
[npm-url]: https://npmjs.org/package/react-console-component
[downloads-image]: https://img.shields.io/npm/dm/react-console-component.svg
Expand Down

0 comments on commit 448da27

Please sign in to comment.