|
|
@@ -1,4 +1,4 @@
|
|
|
-
|
|
|
+
|
|
|
|
|
|
-----
|
|
|
|
|
|
@@ -6,7 +6,7 @@
|
|
|
|
|
|
Huginn is a system for building agents that perform automated tasks for you online. They can read the web, watch for events, and take actions on your behalf. Huginn's Agents create and consume events, propagating them along a directed graph. Think of it as a hackable version of IFTTT or Zapier on your own server. You always know who has your data. You do.
|
|
|
|
|
|
-
|
|
|
+
|
|
|
|
|
|
#### Here are some of the things that you can do with Huginn:
|
|
|
|
|
|
@@ -29,11 +29,11 @@ Join us in our [Gitter room](https://gitter.im/cantino/huginn) to discuss the pr
|
|
|
|
|
|
### Join us!
|
|
|
|
|
|
-Want to help with Huginn? All contributions are encouraged! You could make UI improvements, [add new Agents](https://github.com/cantino/huginn/wiki/Creating-a-new-agent), write [documentation and tutorials](https://github.com/cantino/huginn/wiki), or try tackling [issues tagged with #help-wanted](https://github.com/cantino/huginn/issues?direction=desc&labels=help-wanted&page=1&sort=created&state=open). Please fork, add specs, and send pull requests!
|
|
|
+Want to help with Huginn? All contributions are encouraged! You could make UI improvements, [add new Agents](https://github.com/huginn/huginn/wiki/Creating-a-new-agent), write [documentation and tutorials](https://github.com/huginn/huginn/wiki), or try tackling [issues tagged with #help-wanted](https://github.com/huginn/huginn/issues?direction=desc&labels=help-wanted&page=1&sort=created&state=open). Please fork, add specs, and send pull requests!
|
|
|
|
|
|
Really want a fix or feature? Want to solve some community issues and earn some extra coffee money? Take a look at the [current bounties on Bountysource](https://www.bountysource.com/trackers/282580-huginn).
|
|
|
|
|
|
-Have an awesome idea but not feeling quite up to contributing yet? Head over to our [Official 'suggest an agent' thread ](https://github.com/cantino/huginn/issues/353) and tell us!
|
|
|
+Have an awesome idea but not feeling quite up to contributing yet? Head over to our [Official 'suggest an agent' thread ](https://github.com/huginn/huginn/issues/353) and tell us!
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
@@ -41,27 +41,27 @@ Please checkout the [Huginn Introductory Screencast](http://vimeo.com/61976251)!
|
|
|
|
|
|
And now, some example screenshots. Below them are instructions to get you started.
|
|
|
|
|
|
-
|
|
|
+
|
|
|
|
|
|
-
|
|
|
+
|
|
|
|
|
|
-
|
|
|
+
|
|
|
|
|
|
-
|
|
|
+
|
|
|
|
|
|
-
|
|
|
+
|
|
|
|
|
|
## Getting Started
|
|
|
|
|
|
### Docker
|
|
|
|
|
|
-The quickest and easiest way to check out Huginn is to use the official Docker image. Have a look at the [documentation](https://github.com/cantino/huginn/blob/master/doc/docker/install.md).
|
|
|
+The quickest and easiest way to check out Huginn is to use the official Docker image. Have a look at the [documentation](https://github.com/huginn/huginn/blob/master/doc/docker/install.md).
|
|
|
|
|
|
### Local Installation
|
|
|
|
|
|
If you just want to play around, you can simply fork this repository, then perform the following steps:
|
|
|
|
|
|
-* Run `git remote add upstream https://github.com/cantino/huginn.git` to add the main repository as a remote for your fork.
|
|
|
+* Run `git remote add upstream https://github.com/huginn/huginn.git` to add the main repository as a remote for your fork.
|
|
|
* Copy `.env.example` to `.env` (`cp .env.example .env`) and edit `.env`, at least updating the `APP_SECRET_TOKEN` variable.
|
|
|
* Make sure that you have MySQL or PostgreSQL installed. (On a Mac, the easiest way is with [Homebrew](http://brew.sh/). If you're going to use PostgreSQL, you'll need to prepend all commands below with `DATABASE_ADAPTER=postgresql`.)
|
|
|
* Run `bundle` to install dependencies
|
|
|
@@ -78,8 +78,8 @@ with Huginn locally, set `SEND_EMAIL_IN_DEVELOPMENT` to `true` in your `.env` fi
|
|
|
If you need more detailed instructions, see the [Novice setup guide][novice-setup-guide].
|
|
|
|
|
|
[localhost]: http://localhost:3000/
|
|
|
-[wiki]: https://github.com/cantino/huginn/wiki
|
|
|
-[novice-setup-guide]: https://github.com/cantino/huginn/wiki/Novice-setup-guide
|
|
|
+[wiki]: https://github.com/huginn/huginn/wiki
|
|
|
+[novice-setup-guide]: https://github.com/huginn/huginn/wiki/Novice-setup-guide
|
|
|
|
|
|
### Develop
|
|
|
|
|
|
@@ -96,7 +96,7 @@ All agents have specs! And there's also acceptance tests that simulate running H
|
|
|
|
|
|
Huginn Agents can now be written as external gems and be added to your Huginn installation with the `ADDITIONAL_GEMS` environment variable. See the `Additional Agent gems` section of `.env.example` for more information.
|
|
|
|
|
|
-If you'd like to write your own Huginn Agent Gem, please see [huginn_agent](https://github.com/cantino/huginn_agent).
|
|
|
+If you'd like to write your own Huginn Agent Gem, please see [huginn_agent](https://github.com/huginn/huginn_agent).
|
|
|
|
|
|
Our general intention is to encourage complex and specific Agents to be written as Gems, while continuing to add new general-purpose Agents to the core Huginn repository.
|
|
|
|
|
|
@@ -104,21 +104,21 @@ Our general intention is to encourage complex and specific Agents to be written
|
|
|
|
|
|
### Heroku
|
|
|
|
|
|
-Try Huginn on Heroku: [](https://heroku.com/deploy) (Takes a few minutes to setup. Read the [documentation](https://github.com/cantino/huginn/blob/master/doc/heroku/install.md) while you are waiting and be sure to click 'View it' after launch!)
|
|
|
+Try Huginn on Heroku: [](https://heroku.com/deploy) (Takes a few minutes to setup. Read the [documentation](https://github.com/huginn/huginn/blob/master/doc/heroku/install.md) while you are waiting and be sure to click 'View it' after launch!)
|
|
|
|
|
|
-Huginn launches on the free version of Heroku [with significant limitations](https://github.com/cantino/huginn/blob/master/doc/heroku/install.md). For non-experimental use, we strongly recommend Heroku's 1GB paid plan or our Docker container.
|
|
|
+Huginn launches on the free version of Heroku [with significant limitations](https://github.com/huginn/huginn/blob/master/doc/heroku/install.md). For non-experimental use, we strongly recommend Heroku's 1GB 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.
|
|
|
+Please see [the Huginn Wiki](https://github.com/huginn/huginn/wiki#deploying-huginn) for detailed deployment strategies for different providers.
|
|
|
|
|
|
### Manual installation on any server
|
|
|
|
|
|
-Have a look at the [installation guide](https://github.com/cantino/huginn/blob/master/doc/manual/README.md).
|
|
|
+Have a look at the [installation guide](https://github.com/huginn/huginn/blob/master/doc/manual/README.md).
|
|
|
|
|
|
### Optional Setup
|
|
|
|
|
|
#### Setup for private development
|
|
|
|
|
|
-See [private development instructions](https://github.com/cantino/huginn/wiki/Private-development-instructions) on the wiki.
|
|
|
+See [private development instructions](https://github.com/huginn/huginn/wiki/Private-development-instructions) on the wiki.
|
|
|
|
|
|
#### Enable the WeatherAgent
|
|
|
|
|
|
@@ -134,5 +134,5 @@ Huginn is provided under the MIT License.
|
|
|
|
|
|
Huginn was originally created by [@cantino](https://github.com/cantino) in 2013. Since then, many people's dedicated contributions have made it what it is today.
|
|
|
|
|
|
-[](https://travis-ci.org/cantino/huginn) [](https://coveralls.io/r/cantino/huginn) [](https://gemnasium.com/cantino/huginn) [](https://www.bountysource.com/trackers/282580-huginn?utm_source=282580&utm_medium=shield&utm_campaign=TRACKER_BADGE)
|
|
|
+[](https://travis-ci.org/huginn/huginn) [](https://coveralls.io/r/cantino/huginn) [](https://gemnasium.com/cantino/huginn) [](https://www.bountysource.com/trackers/282580-huginn?utm_source=282580&utm_medium=shield&utm_campaign=TRACKER_BADGE)
|
|
|
|
Andrew Cantino