Skip to content

Commit

Permalink
Updated readme with REAL markdown headers
Browse files Browse the repository at this point in the history
  • Loading branch information
auser committed Oct 12, 2009
1 parent ed686ad commit d9ba58e
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
== Alice
## Alice

Official release post: <a href="http://willcodeforfoo.com/2009/07/13/announcing-alice/">http://willcodeforfoo.com/2009/07/13/announcing-alice/</a>

Expand All @@ -8,7 +8,7 @@ As a queue server, <a href="http://www.rabbitmq.com/">RabbitMQ</a> is super cool

Alice is a RESTful interface to the RabbitMQ server that talks directly through erlang's native interface, <a href="http://www.erlang.org/doc/man/epmd.html">epmd</a>. The purely <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer">RESTful</a> server responds to the same interface as the RabbitMQ's command-line interface and presents a native HTTP interface to the data. <a href="http://alicetheapp.com">Alice</a> is written with <a href="http://code.google.com/p/mochiweb/">Mochiweb</a>.

== Quickstart
## Quickstart

How to get started.

Expand All @@ -31,7 +31,7 @@ Note, you may have to set your cookie when starting Alice with a remote node by
</code></pre>

<pre><code>
== Currently exposed RESTful routes
## Currently exposed RESTful routes
/conn - Current connection information
/exchanges - Current exchanges information
/queues - Current queues
Expand All @@ -44,9 +44,9 @@ Note, you may have to set your cookie when starting Alice with a remote node by

These endpoints all are exposed with the four verbs (get, post, put, delete) and respond in the <a href="http://www.json.org/">JSON</a> format, (except the root / endpoint which responds with text/html).

== Usage
## Usage

== Users
## Users

<pre><code>
# List users
Expand Down Expand Up @@ -107,7 +107,7 @@ Notice that when we list the user that doesn't exist, bob from the second exampl

The same basic usage is applied to all the routes listed, as you can see:

== Connections
## Connections
<pre><code>
# List connections
curl -i http://localhost:9999/conn
Expand All @@ -120,7 +120,7 @@ Content-Length: 287
{"conn":[{"pid":"...","ip":"127.0.0.1","port":"5672","peer_address":"127.0.0.1" ...}]}
</code></pre>

== Exchanges
## Exchanges
<pre><code>
# List the current exchanges
curl -i http://localhost:9999/exchanges
Expand All @@ -133,7 +133,7 @@ Content-Length: 654
{"exchanges":[{"name":"amq.rabbitmq.log","type":"topic","durable":"true","auto_delete":...}
</code></pre>

== Queues
## Queues
<pre><code>
# List the current queues
curl -i http://localhost:9999/queues
Expand All @@ -146,7 +146,7 @@ Content-Length: 60
{"queues":[{"memory":"212988","name":"noises","vhost":"/"}]}
</code></pre>

== Bindings
## Bindings
<pre><code>
# List the current bindings
curl -i http://localhost:9999/bindings
Expand All @@ -159,7 +159,7 @@ Content-Length: 69
{"bindings":[{"queue":"noises","exchange":"","from_queue":"noises"}]}
</code></pre>

== Permissions
## Permissions
<pre><code>
# List permissions
curl -i http://localhost:9999/permissions
Expand Down Expand Up @@ -193,7 +193,7 @@ Content-Length: 38

</code></pre>

== Vhosts
## Vhosts
<pre><code>
# List vhosts
curl -i http://localhost:9999/vhostsHTTP/1.1 200 OK
Expand Down Expand Up @@ -333,7 +333,7 @@ Content-Length: 25
</code></pre>


== Extending
## Extending
Alice is written with the intention of being highly extensible and makes it easy to do so. The controllers respond only to the four verbs with pattern-matching on the routes.

For instance, a very basic controller looks like this:
Expand Down Expand Up @@ -412,17 +412,17 @@ Content-Length: 20

It's as easy as pie to extend Alice.

== Wonderland
## Wonderland

Wonderland is the webUI to Alice. It is driven by the javascript framework <a href="http://code.quirkey.com/sammy">Sammy</a> and Alice in the backend. Because the framework is client-side and accesses the data through <a href="http://en.wikipedia.org/wiki/Ajax_(programming)">ajax</a>, Wonderland can be deployed nearly anywhere.

== Quickstart
## Quickstart
<pre><code>
cd alice
make wonderland
</code></pre>

== Community
## Community
* <a href="http://github.com/auser/alice/issues">Issue tracker</a>
* <a href="http://groups.google.com/group/alice-and-wonderland?lnk=gcimv">Google group</a>
* <a href="irc://irc.freenode.net#poolpartyrb">irc: irc.freenode.net / #poolpartyrb </a>
Expand Down

0 comments on commit d9ba58e

Please sign in to comment.