Skip to content
Browse files

[docs] Updating ReadMe

  • Loading branch information...
1 parent ae0e169 commit b87d33c8c7373d1a861d2acf9a56b9c8c6f4f2f2 @Marak Marak committed Apr 27, 2011
Showing with 11 additions and 8 deletions.
  1. +11 −8 README.md
View
19 README.md
@@ -5,7 +5,7 @@
## Overview
-[Jitsu](http://github.com/nodejitsu/jitsu) is a [Command Line Tool (CLI)](http://en.wikipedia.org/wiki/Command-line_interface) for deploying Node.js applications to the cloud. It's open-source and easy to use. We've designed Jitsu to be suitable for command line beginners, but still be powerful and extensible enough for production usage. If you aren't a fan of the command line or don't have terminal access you can still do everything Jitsu can do through our web admin, [Samurai](http://nodejitsu.com).
+[Jitsu](http://github.com/nodejitsu/jitsu) is a [Command Line Tool (CLI)](http://en.wikipedia.org/wiki/Command-line_interface) for deploying Node.js applications to the cloud. It's open-source and easy to use. We've designed Jitsu to be suitable for command line beginners, but still be powerful and extensible enough for production usage. If you aren't a fan of the command line or don't have terminal access you can still do everything Jitsu can do through our web admin, [Samurai](http://develop.nodejitsu.com/).
Jitsu requires `npm`, the [node package manager](http://npmjs.org).
@@ -24,14 +24,16 @@ Jitsu requires `npm`, the [node package manager](http://npmjs.org).
- Integrated multi-level multi-transport logging support via [Winston](http://github.com/indexzero/winston/)
- Too many to list... seek [further knowledge ](http://github.com/nodejitsu/handbook) or just try it out!
-# One line deployment
+# One-Line Deployment
+
+*( inside the path of your Node.js application )*
- cd /path/to/myapp
jitsu deploy
+
This will create a new application, package.json, and deploy your path to [Nodejitsu](http://nodejitsu.com). If it's your first deployment, you'll be prompted for some information such as *subdomain* and *start script* but it's really easy and we promise it will only take a few seconds.
-If you have any issues deploying your node.js application please feel free to open up an issue on the [Github Issues](https://github.com/nodejitsu/jitsu/issues) section of this page. We'll have someone get back to you in a flash!
+If you have any issues deploying your node.js application please feel free to open up an issue on the [Github Issues](https://github.com/nodejitsu/jitsu/issues) section of this page, we'll have someone get back to you in a flash!
## Usage
@@ -80,7 +82,7 @@ If it's your first time using `jitsu`, you will be prompted to login with an exi
### Help
-Jitsu is mostly self documenting. We suggest just trying it out. All commands will yield friendly messages to you if you specify incorrect parameters. If you find anything difficult to use, please open up a Github issue or pull request!
+`jitsu` is mostly self documenting. We suggest just trying it out. All commands will yield friendly messages if you specify incorrect parameters. If you find anything difficult to use, please open up a [Github issue](https://github.com/nodejitsu/jitsu/issues) or pull request!
jitsu help
jitsu help apps
@@ -90,13 +92,14 @@ Jitsu is mostly self documenting. We suggest just trying it out. All commands wi
## .jitsuconf file
-All configuration data for your local `jitsu` install is located in the *.jitsuconf* file located in your home directory. Directly modifying this file is not really advised. You should be able to make all configuration changes via:
+All configuration data for your local `jitsu` install is located in the *.jitsuconf* file in your home directory. Directly modifying this file is not really advised. You should be able to make all configuration changes via:
jitsu config
-## Libraries
+
<a name="Libraries"></a>
-The [Nodejitsu](http://nodejitsu.com) team and friends have been building and using these tools actively for the past two years. They are the most used Node libraries (see: [http://search.npmjs.org/](http://search.npmjs.org/)) and are actively maintained. Each tool serves a specific function and we highly suggest you check each one out individually if you wish to increase your knowledge of Node.js
+## Libraries
+`jitsu` is built on a few well developed, well maintained Node.js libraries. The [Nodejitsu](http://nodejitsu.com) team and friends have been building and using these projects actively for the past two years. They are the most used Node libraries (see: [http://search.npmjs.org/](http://search.npmjs.org/)) and are actively maintained by Nodejitsu and other core members of the Node.js community. Each library serves a specific function and we highly suggest you check each one out individually if you wish to increase your knowledge of Node.js
- [npm](http://npmjs.org) - Node Package Manager
- [colors](http://github.com/marak/colors) - Terminal Colors module

0 comments on commit b87d33c

Please sign in to comment.
Something went wrong with that request. Please try again.