Merge branch 'master' of github.com:cantino/huginn

Andrew Cantino 11 years ago
parent
commit
ece41b2817
1 changed files with 10 additions and 1 deletions
  1. 10 1
      README.md

+ 10 - 1
README.md

@@ -4,14 +4,19 @@
4 4
 
5 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.  We're just getting started, but here are some of the things you can do with Huginn right now:
6 6
 
7
-
7
+![the origin of the name](doc/imgs/the-name.png)
8 8
 
9 9
 Control your own data, run your own data hub.
10 10
 You know where the data is and who has it.  Don't be afraid to log stuff because of where it is.
11 11
 
12 12
 Make agents that serve you.
13 13
 
14
+And now, some example screenshots.  Below them are instructions to get you started.
14 15
 
16
+![Event flow diagram](doc/imgs/diagram.png)
17
+![Loging your location over time](doc/imgs/my-locations.png)
18
+![Making a new agent](doc/imgs/new-agent.png)
19
+![Example list of agents](doc/imgs/your-agents.png)
15 20
 
16 21
 ## Getting Started
17 22
 
@@ -47,6 +52,10 @@ Deployment right now is configured with Capistrano, Unicorn, and nginx.  You sho
47 52
 
48 53
 In order to use the WeatherAgent you need an [API key with Wunderground](http://www.wunderground.com/weather/api/).  Signup for one and then put it in `app/models/agents/weather_agent.rb` in the `wunderground` method.
49 54
 
55
+## Logging your location to the UserLocationAgent
56
+
57
+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.
58
+
50 59
 #### Enable DelayedJobWeb for handy delayed_job monitoring and control
51 60
 
52 61
 * Edit `config.ru`, uncomment the DelayedJobWeb section, and change the DelayedJobWeb username and password.