Browse files

Updated README to include installation instructions.

  • Loading branch information...
1 parent 6ba7476 commit 02acaa45709f2367dae0660626edbf7139484d48 @jlleblanc committed Feb 17, 2012
Showing with 8 additions and 0 deletions.
  1. +8 −0 README.mdown
8 README.mdown
@@ -2,6 +2,14 @@
This module assumes you have an existing Joomla installation and wish to connect to it. The constructor takes either a path to the root of the Joomla installation, or a JavaScript object literal with the configuration details. When the module connects to the database, it executes the callback function you pass in.
+## Installation
+Using `npm`:
+ npm install joomla
+You can also clone this repository into your `node_modules` directory.
## Examples
### Path style - (requires PHP CLI)

0 comments on commit 02acaa4

Please sign in to comment.