Skip to content

Commit

Permalink
Cleanup docs structure
Browse files Browse the repository at this point in the history
  • Loading branch information
jotaen committed Sep 1, 2016
1 parent 485e785 commit b47b33e
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 17 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@

webshell.js is a command line interpreter that runs in your browser.

## Requirements
## Overview

- NodeJS > 5.0.0
#### Live Demo:
[See webshell.js in action](http://static.jotaen.net/webshell.js/examples/basic.html)

## Install, build
#### Download:
[Grab the latest version](http://static.jotaen.net/webshell.js/dist/webshell.js)

1. Clone the repo
2. Run `npm install`
3. Run `npm run dist`
#### Documentation:
[Read the docs](docs/index.md)

The build output can be found here: `dist/webshell.js`
## Get started

## Usage

1. Build the webshell bundle (see above) and include the generated file with a `<script src="">` tag in your webpage.
2. Create an empty `<div>` element with a custom id, e.g.: `<div id="atari"></div>`
3. Call the function `createWebshell()` and pass it the id of the div-element, e.g.: `createWebshell('atari')`
1. Download or build `webshell.js`
2. Include `webshell.js` file with a `<script src="">` tag in your webpage.
3. Create an empty `<div>` element with a custom id, e.g.: `<div id="atari"></div>`
4. Call the function `createWebshell()` and pass it the id of the div-element, e.g.: `createWebshell('atari')`

See [the basic example](examples/basic.html).

Expand Down
4 changes: 0 additions & 4 deletions docs/README.md

This file was deleted.

13 changes: 13 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Documentation

## Requirements

- NodeJS 6

## Install, build

1. Clone the repo
2. Run `npm install`
3. Run `npm run dist`

The build output is in the `dist` folder.
1 change: 0 additions & 1 deletion docs/usage.md

This file was deleted.

0 comments on commit b47b33e

Please sign in to comment.