Skip to content

Commit

Permalink
added emoji
Browse files Browse the repository at this point in the history
  • Loading branch information
nitin42 authored Aug 4, 2017
1 parent dba3014 commit 629509e
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Ensure that `terminal-in-react/lib/css/index.css` is loaded

## Working

### Adding commands
### Adding commands ✍️

To add your own command, use prop `commands` which accepts an object. This objects then maps `command name -> command function`.

Expand All @@ -120,7 +120,7 @@ Let's take an example. You want to open a website with a command `open-google`
<Terminal commands={{ 'open-google': () => window.open("https://www.google.com/", "_blank")}} />
```

### Adding description of your command
### Adding description of your command πŸ’πŸΌβ€β™‚οΈ

Add a description of your command using prop `description`.

Expand All @@ -141,15 +141,15 @@ It does so by default.
<img src="http://g.recordit.co/a6D6PCtTcL.gif"/>
</p>

### Command passthrough
### Command passthrough

You can have the terminal pass out the cmd that was input

```jsx
<Terminal commandPassThrough={cmd => `-PassedThrough:${cmd}: command not found`} />
```

### Async handling of commands
### Async handling of commands 😎
you can also handle the result with a callback
```jsx
<Terminal
Expand All @@ -175,7 +175,7 @@ you can also handle the result with a callback
This will hide the option color, show and clear.


### Advanced commands
### Advanced commands πŸ‘¨β€πŸ’»

You can give your commands options and get them back parsed to the method.
Using this method will also give your command a build in help output.
Expand Down Expand Up @@ -296,23 +296,23 @@ Awesome! Right? Let us know if you make something interesting πŸ˜ƒ
<img src="https://i.gyazo.com/3e719f4091cbd72f3e1f99209493e50d.gif" />
</p>

### Multiline input
### Multiline input πŸ€ΉπŸΌβ€β™€οΈ

via `shift + enter`

<p align="center">
<img src="http://g.recordit.co/AznpOohzJL.gif" />
</p>

### Check history of your commands
### Check history of your commands πŸ–±οΈ

using arrow down and up keys

<p align="center">
<img src="https://i.gyazo.com/6fa55a8fbb961787c51e406e612e0bb8.gif" />
</p>

### Keyboard shortcuts
### Keyboard shortcuts ⌨
You can define keyboard shortcuts. They have to be grouped by os. The three available are
`win`, `darwin`, and `linux`. You can group multiple os by a `,` for example if the
shortcut was for all platforms `win,darwin,linux` would be fine as a key
Expand Down

0 comments on commit 629509e

Please sign in to comment.