Skip to content

Commit

Permalink
docs(README): add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ctaylo21 committed Aug 4, 2019
1 parent a68eb50 commit 78d06ff
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ A web-based terminal powered by React. Check out the [demo](https://ctaylo21.git

- [Termy the Terminal](#termy-the-terminal)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [Commands](#commands)
- [`cd [DIRECTORY]`](#cd-directory)
Expand All @@ -54,6 +55,13 @@ A web-based terminal powered by React. Check out the [demo](https://ctaylo21.git
- [`rm [OPTIONS] [FILE]`](#rm-options-file)
- [`help`](#help)

## Installation
The package can be installed via NPM:

npm i termy-the-terminal

You will need to install the React and ReactDOM packages separately as they aren't included in this package.

## Usage

```jsx
Expand Down

0 comments on commit 78d06ff

Please sign in to comment.