Update README with links to new documentation
Dominik Sander
1 changed files with 12 additions and 2 deletions
+ 12
- 2
README.md
@@ -53,7 +53,11 @@ And now, some example screenshots. Below them are instructions to get you start |
||
| 53 | 53 |
|
| 54 | 54 |
## Getting Started |
| 55 | 55 |
|
| 56 |
-### Quick Start |
|
| 56 |
+### Docker |
|
| 57 |
+ |
|
| 58 |
+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). |
|
| 59 |
+ |
|
| 60 |
+### Local Installation |
|
| 57 | 61 |
|
| 58 | 62 |
If you just want to play around, you can simply fork this repository, then perform the following steps: |
| 59 | 63 |
|
@@ -82,12 +86,18 @@ All agents have specs! Test all specs with `bundle exec rspec`, or test a specif |
||
| 82 | 86 |
|
| 83 | 87 |
## Deployment |
| 84 | 88 |
|
| 85 |
-Try Huginn on Heroku: [](https://heroku.com/deploy) (Takes a few minutes to setup. Be sure to click 'View it' after launch!) |
|
| 89 |
+### Heroku |
|
| 90 |
+ |
|
| 91 |
+Try Huginn on Heroku: [](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!) |
|
| 86 | 92 |
|
| 87 | 93 |
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. |
| 88 | 94 |
|
| 89 | 95 |
Please see [the Huginn Wiki](https://github.com/cantino/huginn/wiki#deploying-huginn) for detailed deployment strategies for different providers. |
| 90 | 96 |
|
| 97 |
+### Manual installation on any server |
|
| 98 |
+ |
|
| 99 |
+Have a look at the [installation guide](./doc/manual/README.md). |
|
| 100 |
+ |
|
| 91 | 101 |
### Optional Setup |
| 92 | 102 |
|
| 93 | 103 |
#### Setup for private development |