# c

> The best project ever.

## Getting Started
Before anything taking its part, you should install [node](http://nodejs.org) and "cortex".

#### Install Node

Visit [http://nodejs.org](http://nodejs.org), download and install the proper version of nodejs.

#### Install Cortex

    # maybe you should use `sudo`
    npm install -g cortex

## Using c In Your Project

First, install 'c' directly with `ctx install` (recommended)
	
	ctx install c --save
	
or, you could update your package.json manually
    
    dependencies: {
        'c': '<version-you-want>'
    }
    
and install dependencies
	
	ctx install
    
Then, use `require` method in your module
    
    var c = require('c');
    
Finally, start cortex server
    
    ctx server
    
Then cortex will care all the rest.


## API Documentation

### c: constructor
': constructor' means the `module.exports` of module 'c' is a constructor that we should use it with the `new` keyword

	new c(options)
	
#### options
- options.name {String}



### c.\<method-name\>(arguments)
Means this is a static method of `module.exports`

#### arguments
// arguments description here

### .\<method-name\>(arguments)
Mean this is a method of the instance

#### arguments
// arguments description here