Skip to content

Commit

Permalink
[docs] Spec'd out first round of API and documentation for review. So…
Browse files Browse the repository at this point in the history
…me sections are incomplete.
  • Loading branch information
Marak committed Jan 31, 2011
1 parent 992dd64 commit 419bbe6
Showing 1 changed file with 112 additions and 0 deletions.
112 changes: 112 additions & 0 deletions README.md
@@ -0,0 +1,112 @@


# noc
(**N**odejitsu **O**perations **C**ontroller)

## noc is a CLI tool for easily deploying node.js applications on the Nodejitsu platform


## INSTALLATION

sudo npm install noc


## USAGE

1. Get an account.
2. Prepare an package.json for your application OR select an application from the <a href="#marketplace">marketplace</a>
3. Boom! Deploy.


## User API


### Inviting a new user

noc user invite [email]

*sends email to user with invite code*

### Creating a new user

noc user create [username] [password] [email] [pathToSSHkey] [invitecode]

*invite code is optional. If you don't provide a valid invitecode, you will be provided one via email.*

### Confirming an account

noc user confirm [invite code]

*confirms a user account based on invite code*

### Resetting an account's password

noc user reset [username]

*sends a reset password email to username*


## Application API

### Listing applications

noc app ls

### Starting / Stopping / Restarting applications

noc app [appname] [start|stop|restart]


## Deployment API

### Deploying a package.json from your local machine

noc deploy /pathTo/myapp/

*/pathTo/myapp/ must point to a folder which contains a valid package.json <a href="#prepare">Read More</a>*

### Deploying applications from the Marketplace

noc market buy [appname]

*prompts user to specify a domain name*

## Marketplace API

### Listing Marketplace applications

noc market ls

### Publishing your own application to the Marketplace

noc market publish /pathTo/myApp

*/pathTo/myapp/ must point to a folder which contains a valid package.json <a href="#prepare">Read More</a>*

## PREPARING YOUR APPLICATION FOR DEPLOYMENT
<a name="prepare"/>
### Building a valid package.json

TODO:

## Specify your repository type

TODO:

## Specify your starting script

TODO:

## Ensure your npm dependencies are listed correctly

TODO:

## Bundle any dependencies which are not available on npm

TODO:

## THE MARKETPLACE

The Nodejitsu Marketplace is an store where you can purchase node.js applications. We currently have several free applications and are always accepting new ones!

TODO:

0 comments on commit 419bbe6

Please sign in to comment.