Bumped version number to 0.9.1. Updated README.

README.md

@@ -1,25 +1,58 @@
-# Genie ACS
+# GenieACS
 
-A blazing fast TR-069 auto configuration server (ACS) built with node.js and MongoDB.
+GenieACS is a *blazing fast* TR-069 auto configuration server (ACS) built with Node.js, Redis, and MongoDB. It's technology neutral and configurable to fit any service provider needs. This is the core back end component. Official front end GUI is available at https://github.com/zaidka/genieacs-gui.
 
 ## Features
 
-* *Massively concurrent*: Can handle hundreds of thousands of connected devices on a single server even with low inform interval.
-* *Preset-based configurations*: Predefine sets of configurations that devices will pick up and apply based on given preconditions.
-* *Tagging*: Use tags to group devices for more manageable presets.
-* *Searching*: Query for devices on any parameter (supports all common operators including regular expressions).
-* *Parameter aliases*: Define aliases to unify parameter paths from different types of devices. Aliases behave like normal parameters (i.e. can query on it or set it's value).
+* **Massively concurrent**: Can handle hundreds of thousands of connected devices on a single server even with low inform interval.
+* **Preset-based configuration**: Define sets of configurations that devices will pick up and apply as needed based on given preconditions.
+* **Tagging**: Use tags to group devices for more manageable presets.
+* **Searching**: Query for devices on any parameter (supports all common operators including regular expressions).
+* **Parameter aliasing**: Define aliases to unify parameter paths from different types of devices. Aliases behave like normal parameters (i.e. can be queried or modified).
+* **Extensive API**: A simple yet rich HTTP-based API allows easy integration with other system.
 
-## Requirements
+## Getting started
 
-* [MongoDB](http://mongodb.org)
-* [Node.js driver for MongoDB](https://github.com/mongodb/node-mongodb-native)
-* [Memcached](http://memcached.org)
-* [node-memcached](https://github.com/3rd-Eden/node-memcached)
-* [Libxmljs](https://github.com/polotek/libxmljs)
+Install [Node.js](http://nodejs.org/), [Redis](http://redis.io/), and [MongoDB](http://www.mongodb.org/). Refer to the corresponding documentation for installation guides. Use NPM to install GenieACS and its dependencies by typing:
 
-## Installation notes
+    npm install genieacs
 
-* Make sure you enable sockets for memcached and mongodb
-* Genie keeps all running tasks in memcached. Increase memcached cache size depending on the number of available devices.
+Alternatively, you can use git to get the latest development version (not recommended for production use):
+
+    cd /opt
+    git clone https://github.com/zaidka/genieacs.git
+    cd genieacs
+    npm install
+
+System configuration files can be found under "config" directory. Copy the sample config files provided by removing the "-sample" suffix and modify as necessary.
+
+Finally, run the following in GNU Screen session or something similar:
+
+    node acs
+
+This is the service that the CPEs will communicate with. It listens to port 7547 by default (see config/config.json). Configure the ACS URL of your devices accordingly.
+
+    node api
+
+This is the API module. It exposes the API on port 7557 by default. This is needed for the GUI front end to communicate with.
+
+    node files
+
+This is the file server from which the CPEs will download firmware images and other types of files.
+
+For further details about installation and configuration, refer to the [wiki section](https://github.com/zaidka/genieacs/wiki).
+
+You may now proceed with installing [GenieACS GUI front end](https://github.com/zaidka/genieacs-gui).
+
+## Support
+
+Documentation is still work in progress. Feel free to contact me if you require any assistance in installation, configuration, or using the APIs.
+
+You may submit bug reports or feature requests [here](https://github.com/zaidka/genieacs/issues).
+
+For commercial support options, please contact me.
+
+## Contributing
+
+Contributions are welcome. Fork this repo and open a pull request and wait for feedback. You can also contribute by enhancing the documentation in the [wiki section](https://github.com/zaidka/genieacs/wiki).
 

package.json

@@ -1,18 +1,18 @@
 {
   "name": "genieacs",
-  "version": "0.9.0",
-  "description": "A blazing fast TR-069 auto configuration server (ACS) built with node.js and MongoDB",
+  "version": "0.9.1",
+  "description": "A blazing fast TR-069 auto configuration server (ACS) built with Node.js, Redis, and MongoDB",
   "directories": {
     "test": "test"
   },
   "dependencies": {
     "libxmljs": "~0.8.1",
-    "redis": "~0.9.0",
+    "redis": "~0.10.0",
     "hiredis": "~0.1.15",
-    "mongodb": "~1.3.18"
+    "mongodb": "~1.3.23"
   },
   "devDependencies": {
-    "coffee-script": "~1.6.3"
+    "coffee-script": "~1.7.1"
   },
   "scripts": {
     "prepublish": "coffee -c *.coffee",
@@ -29,6 +29,5 @@
   ],
   "author": "Zaid Abdulla",
   "license": "MIT",
-  "readmeFilename": "README.md",
-  "gitHead": "af9ca0c2aede261efe09305e67ad2442940e1436"
+  "readmeFilename": "README.md"
 }