Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update README.md

Rearranged a bit and added a link to the docs
  • Loading branch information...
commit 8ef904dff2ba54ff313dc033ad011f35423e4c29 1 parent ca11784
@Techwraith Techwraith authored
Showing with 25 additions and 11 deletions.
  1. +25 −11 README.md
View
36 README.md
@@ -1,8 +1,21 @@
-## Geddy web framework for Node.js
-- - -
+# Geddy
+####A simple, structured web framework for Node
+
+```
+$ npm install -g geddy
+$ geddy app my_app
+$ cd my_app
+$ geddy
+// app now running on localhost:4000
+```
+
[![build status](https://secure.travis-ci.org/mde/geddy.png)](http://travis-ci.org/mde/geddy)
+### Documentation
+
+Docs are located on the GeddyJS website: http://geddyjs.org/documentation
+
### Goals
* Easy to use
@@ -16,6 +29,7 @@ but still let you get under the hood and tinker if you want.
* Powerful, flexible router
* Easy resource-based routing
+ * Database adapters for Postgres, MongoDB, Riak, and in-memory
* App, resource and scaffold generators
* Content-negotiation
* Session support (in-memory, cookie)
@@ -32,6 +46,15 @@ Apache License, Version 2
Geddy requires version 0.6.x of Node.js or higher, and the
[Jake](https://github.com/mde/jake) JavaScript build-tool.
+### Installing with [NPM](http://npmjs.org/)
+
+```
+[sudo] npm -g install geddy
+```
+
+Note: Geddy (specifically, the generators) is a system-level
+tool, and wants to be installed globally.
+
### Installing from Github
To get Geddy from Github and install it do:
@@ -56,15 +79,6 @@ If you do install Geddy somewhere special, you'll need to add the
"bin" directory in the install target to your PATH to get access
to the `geddy` executable.
-### Installing with [NPM](http://npmjs.org/)
-
-```
-[sudo] npm -g install geddy
-```
-
-Note: Geddy (specifically, the generators) is a system-level
-tool, and wants to be installed globally.
-
### Creating a Geddy application
To create Geddy applications simply run `geddy app <name>`.
Please sign in to comment.
Something went wrong with that request. Please try again.