Skip to content

Commit

Permalink
back to good readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Evan Tahler committed Dec 6, 2012
1 parent cc22bcf commit b053a66
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions readme.md
Expand Up @@ -7,29 +7,32 @@
<img src="https://raw.github.com/evantahler/actionHero/master/public/logo/actionHero.png" height="250"/>

## Who is the actionHero?
actionHero is a [node.js](http://nodejs.org) **API framework** for both **tcp sockets**, **web sockets**, and **http clients**. The goal of actionHero are to create an easy-to-use toolkit for making **reusable** & **scalable** APIs. clients connected to an actionHero server can **consume the api**, **consume static content**, and **communicate with each other**.
actionHero is a [node.js](http://nodejs.org) **API framework** for many types fo clients. The goal of actionHero is to create an easy-to-use toolkit for making **reusable** & **scalable** APIs. clients connected to an actionHero server can [**consume the api**](https://github.com/evantahler/actionHero/wiki/Actions), [**consume static content**](https://github.com/evantahler/actionHero/wiki/File-Server), and [**communicate with each other**](https://github.com/evantahler/actionHero/wiki/Chat).

actionHero servers can process both requests and tasks (delayed actions like `send e-mail` or other background jobs). actionHero servers can also run in a cluster (on the same or multiple machines) to work in concert to handle your load.
Currently actionHero supports:

The actionHero API defines a single access point and accepts GET, POST, PUT and DELETE input along with persistent connection via TCP or web sockets. You define **Actions** which handle input and response, such as "userAdd" or "geoLocate". HTTP, HTTPS, and TCP clients can all use these actions. The actionHero API is not inherently "RESTful" (which is meaningless for persistent socket connections) but can be extended to be so if you wish.
- [Web Clients](https://github.com/evantahler/actionHero/wiki/Web-Clients): HTTP, HTTPS
- [Socket Clients](https://github.com/evantahler/actionHero/wiki/TCP-Clients): TCP (telnet), TLS
- [Web Socket (socket.io) clients](https://github.com/evantahler/actionHero/wiki/Web-Socket-Clients): HTTP, HTTPS

actionHero will also serve static files for you, but actionHero is not meant to be a 'rendering' server (like express or rails).
actionHero servers can process both requests and [tasks](https://github.com/evantahler/actionHero/wiki/Tasks) (delayed actions like `send e-mail` or other background jobs). Taks can be enqued as a delayed job, or run periodically. actionHero servers can also run in a cluster (on the [same](https://github.com/evantahler/actionHero/wiki/Running-ActionHero) or [multiple machines](https://github.com/evantahler/actionHero/wiki/actionCluster)) to work in concert to handle your load. Tasks can be alocated to run on `any` or `all` of the servers in yoru cluster.

## Quick Start

npm install actionHero
./node_modules/.bin/actionHero generate
./node_modules/.bin/actionHero start
npm install actionHero
./node_modules/.bin/actionHero generate
./node_modules/.bin/actionHero start

## Want more?

- [Getting Started](https://github.com/evantahler/actionHero/wiki/Getting-Started)
- [Running actionHero](https://github.com/evantahler/actionHero/wiki/Running-ActionHero)
- [Read the documentation on the wiki](https://github.com/evantahler/actionHero/wiki)
- [Check out the project history](https://github.com/evantahler/actionHero/blob/master/versions.md)

## Who?
* The primary creator of the actionHero framework is [Evan Tahler](http://evantahler.com)
* The primary creator of the actionHero framework is [Evan Tahler](http://evantahler.com), but many others [have helped](https://github.com/evantahler/actionHero/graphs/contributors)
* Logo by [Ali Spagnola](http://alispagnola.com/)
* If you want to contribute to actionHero, contribute to the conversation on [github](https://github.com/evantahler/actionHero)

###
###

0 comments on commit b053a66

Please sign in to comment.