Skip to content

Commit

Permalink
Update README with links to new documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dsander committed Aug 18, 2015
1 parent cec02c1 commit b35efc2
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,11 @@ And now, some example screenshots. Below them are instructions to get you start

## Getting Started

### Quick Start
### Docker

The quickest and easiest way to check out Huginn is to use the offical Docker image. Have a look at the [documentation](./doc/docker/install.md).

### Local Installation

If you just want to play around, you can simply fork this repository, then perform the following steps:

Expand Down Expand Up @@ -82,12 +86,18 @@ All agents have specs! Test all specs with `bundle exec rspec`, or test a specif

## Deployment

Try Huginn on Heroku: [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy) (Takes a few minutes to setup. Be sure to click 'View it' after launch!)
### Heroku

Try Huginn on Heroku: [![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy) (Takes a few minutes to setup. Read the [documentation](./doc/heroku/install.md) while you are waiting and be sure to click 'View it' after launch!)

Huginn works on the free version of Heroku [with limitations](https://github.com/cantino/huginn/wiki/Run-Huginn-for-free-on-Heroku). For non-experimental use, we recommend Heroku's cheapest paid plan or our Docker container.

Please see [the Huginn Wiki](https://github.com/cantino/huginn/wiki#deploying-huginn) for detailed deployment strategies for different providers.

### Manual installation on any server

Have a look at the [installation guide](./doc/manual/README.md).

### Optional Setup

#### Setup for private development
Expand Down

0 comments on commit b35efc2

Please sign in to comment.