Permalink
Browse files

Merge branch 'master' of github.com:mde/geddy

  • Loading branch information...
mde
mde committed Oct 13, 2012
2 parents 32eef6b + 2219977 commit 968ed6c99e906665b42e3f862be2150c8d795087
Showing with 39 additions and 14 deletions.
  1. +25 −11 README.md
  2. +12 −1 docs/4-models.md
  3. +2 −2 site/app/views/layouts/application.html.jade
View
@@ -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>`.
View
@@ -290,7 +290,18 @@ user.updateProperties({
#### static
-docs coming soon
+Static methods can be added by creating a method on the model definition object.
+
+```
+var User = function () {
+ this.property('login', 'string', {required: true});
+ this.property('password', 'string', {required: true});
+};
+
+User.findByLogin = function (login, callback) {
+ User.all({login: login}, callback);
+}
+```
* * *
@@ -56,13 +56,13 @@ html(lang="en")
span.copyright copyright 2112
ul.links
li.link
- a(href="/home") home
+ a(href="/") home
li.link
a(href="/documentation") documentation
li.link
a(href="/tutorial") tutorial
li.link
- a(href="/blog") blog
+ a(href="/changelog") changelog
li.link
a(href="/community") community
li.link

0 comments on commit 968ed6c

Please sign in to comment.