Update README.md

Andrew Cantino 10 years ago
parent
commit
13b8fbbedc
1 changed files with 7 additions and 10 deletions
  1. 7 10
      README.md

+ 7 - 10
README.md

@@ -2,7 +2,7 @@
2 2
 
3 3
 ## What is Huginn?
4 4
 
5
-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 event flow graph.  Think of it as Yahoo! Pipes plus IFTTT on your own server.  You always know who has your data.  You do.
5
+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 Yahoo! Pipes plus IFTTT on your own server.  You always know who has your data.  You do.
6 6
 
7 7
 ![the origin of the name](doc/imgs/the-name.png)
8 8
 
@@ -10,12 +10,13 @@ Huginn is a system for building agents that perform automated tasks for you onli
10 10
 
11 11
 * Track the weather and get an email when it's going to rain (or snow) tomorrow ("Don't forget your umbrella!")
12 12
 * List terms that you care about and receive emails when their occurrence on Twitter changes.  (For example, want to know when something interesting has happened in the world of Machine Learning?  Huginn will watch the term "machine learning" on Twitter and tell you when there is a large spike.)
13
-* Watch for air travel deals
13
+* Watch for air travel or shopping deals
14 14
 * Follow your project names on Twitter and get updates when people mention them
15 15
 * Scrape websites and receive emails when they change
16
+* Connect to Adioso, HipChat, Basecamp, Growl, FTP, IMAP, Jabber, JIRA, MQTT, nextbus, Pushbullet, Pushover, RSS, Bash, Slack, StubHub, translation APIs, Twilio, Twitter, Wunderground, and Weibo, to name a few.
16 17
 * Compose digest emails about things you care about to be sent at specific times of the day
17 18
 * Track counts of high frequency events and send an SMS within moments when they spike, such as the term "san francisco emergency"
18
-* Watch public transit
19
+* Send and receive WebHooks
19 20
 * Run arbitrary JavaScript Agents on the server
20 21
 * Track your location over time
21 22
 * Create Amazon Mechanical Turk workflows as the inputs, or outputs, of agents.  ("Once a day, ask 5 people for a funny cat photo; send the results to 5 more people to be rated; send the top-rated photo to 5 people for a funny caption; send to 5 final people to rate for funniest caption; finally, post the best captioned photo on my blog.")
@@ -66,7 +67,7 @@ If you need more detailed instructions, see the [Novice setup guide][novice-setu
66 67
 
67 68
 ## Deployment
68 69
 
69
-Please see [the Huginn Wiki](https://github.com/cantino/huginn/wiki#deploying-huginn) for detailed deployment strategies for different providers.
70
+Huginn can run on Heroku for free!  Please see [the Huginn Wiki](https://github.com/cantino/huginn/wiki#deploying-huginn) for detailed deployment strategies for different providers.
70 71
 
71 72
 ### Optional Setup
72 73
 
@@ -76,11 +77,7 @@ See [private development instructions](https://github.com/cantino/huginn/wiki/Pr
76 77
 
77 78
 #### Enable the WeatherAgent
78 79
 
79
-In order to use the WeatherAgent you need an [API key with Wunderground](http://www.wunderground.com/weather/api/). Signup for one and then change value of `api_key: your-key` in your seeded WeatherAgent.
80
-
81
-#### Logging your location to the UserLocationAgent
82
-
83
-You can use [Post Location](https://github.com/cantino/post_location) on your iPhone to post your location to an instance of the UserLocationAgent.  Make a new one to see instructions.
80
+In order to use the WeatherAgent you need an [API key with Wunderground](http://www.wunderground.com/weather/api/). Signup for one and then change the value of `api_key: your-key` in your seeded WeatherAgent.
84 81
 
85 82
 #### Enable DelayedJobWeb for handy delayed\_job monitoring and control
86 83
 
@@ -102,7 +99,7 @@ Some of us are hanging out there, come and say hello.
102 99
 
103 100
 ## Contribution
104 101
 
105
-Huginn is a work in progress and is hopefully just getting started.  Please get involved!  You can [add new Agents](https://github.com/cantino/huginn/wiki/Creating-a-new-agent), expand the [Wiki](https://github.com/cantino/huginn/wiki), or help us simplify and strengthen the Agent API or core application.
102
+Huginn is a work in progress and is just getting started.  Please get involved!  You can [add new Agents](https://github.com/cantino/huginn/wiki/Creating-a-new-agent), expand the [Wiki](https://github.com/cantino/huginn/wiki), or help us simplify and strengthen the Agent API or core application.
106 103
 
107 104
 Please fork, add specs, and send pull requests!
108 105