GitHub-Mirror/huginn
2
0
Fork 0
mirror of https://github.com/Fishwaldo/huginn.git synced 2025-03-15 19:31:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README with links to new documentation

Browse source
This commit is contained in:
Dominik Sander 2015-08-01 18:48:48 +02:00
parent cec02c1bd6
commit b35efc2eec
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -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:
@ -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