forked from mtodd/halcyon
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
61 lines (37 loc) · 1.65 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
= Halcyon JSON Application Framework
A JSON Web Application Framework for developing lightweight applications
interfaced via JSON-encoded HTTP requests. This is ideal for back end
applications serving functionality for other applications.
== On Rack
Halcyon is based off of Rack. Rejoice, Rack is amazing.
== Development
Halcyon is currently undergoing major refactoring and restructuring. The API is
subject to change up until the official 0.5.0 release.
== Installation
A Gem of Halcyon is available. You can install it with:
$ sudo gem install halcyon
Alternatively, you can install the latest development efforts from the git
repository, located at http://github.com/mtodd/halcyon:
$ git clone git://github.com/mtodd/halcyon.git
$ cd halcyon; rake install
Don't forget to install the JSON gem for improved performance:
$ sudo gem install json
== Usage
Usage instructions will be updated when the application generation code is
completed.
== Contact
Please mail bugs, suggestions and patches to <mailto:[email protected]>.
You are also welcome to join the #halcyon channel on irc.freenode.net.
Our website is up so stop by and check out what's going down. Our address is
http://halcyon.rubyforge.org/. On there you will find information about our
mailing list as well, so do stop by.
== Thanks To
* Bill Marquette, typo correction, reviewing examples
* Elliott Cable, missing dependency, Thin testing
* ramstedt, Mongrel on JRuby port numericality issue (#14)
== Links
Halcyon:: <http://halcyon.rubyforge.org/>
Aurora:: <http://aurora.rubyforge.org/>
Rack:: <http://rack.rubyforge.org/>
JSON:: <http://json.rubyforge.org/>
Matt Todd:: <http://maraby.org/>