Skip to content

Commit

Permalink
docs(readme): Add quick start example and toc
Browse files Browse the repository at this point in the history
  • Loading branch information
d4rkr00t committed Sep 30, 2016
1 parent b694ab2 commit f8f74c2
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 6 deletions.
33 changes: 27 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,33 @@ If you want solutions which are better for production usage you can take a look

Even though Aik has extra features for React, the main goal is to be open for any JavaScript framework or library.

## Quick Start

```sh
npm i -g aik
aik index.js
```

![aik quick start](/assets/quick-start.png)

## Table of Content

* [Objectives](#objectives)
* [Quick Start](#quick-start)
* [Features](#features)
* [Run web server with JavaScript file](#run-web-server-with-javascript-file)
* [Automatically install npm modules](#automatically-install-npm-modules)
* [Custom templates](#custom-templates)
* [Hot reload](#hot-reload)
* [Latest and Greatest technologies for frontend development](#latest-and-greatest-technologies-for-frontend-development)
* [Linting](#linting)
* [Production ready build](#production-ready-build)
* [Expose web server to the real world](#expose-web-server-to-the-real-world)
* [Usage](#usage)
* [Alternatives](#alternatives)
* [License](#license)
* [Contributing](#contributing)

## Features

### Run web server with JavaScript file
Expand Down Expand Up @@ -123,12 +150,6 @@ Optionally, by providing '-n' flag you can expose web server to the real world u
aik index.js -n # option for enabling ngrok
```

## Install

```sh
npm install -g aik
```

## Usage

```sh
Expand Down
Binary file added assets/quick-start.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f8f74c2

Please sign in to comment.