Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
astralarya committed Jun 1, 2016
1 parent 75ee822 commit 3a08029
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# react-console
Simple React console emulator

Inspired by [chrisdone/jquery-console](https://github.com/chrisdone/jquery-console).

## Example

Simple prompt that echoes back input:
Expand All @@ -21,7 +19,7 @@ let EchoConsole = React.createClass({

Include `dist/react-console.js` and `dist/react-console.css` in your html.

See `example/echo.tsx` for an example using Typescript.
See (example/echo.tsx)[example/echo.tsx] for an example using Typescript.


## Props
Expand All @@ -45,3 +43,8 @@ Properties you can pass to the console element
| log | function(...messages: any): void | Log messages to the console. If string, print the value, otherwise, print the JSON value of the message.
| logX | function(type: string, ...messages: any): void | Log messages of a particular type to the console. The messages will be given the class `react-console-message-{type}`.
| return | function(): void | Signal the current command has finished and a new prompt should be displayed.


## Awknoledgements

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

0 comments on commit 3a08029

Please sign in to comment.