Finished docs. Uniformed events

Author: Skullbock

README.md

@@ -209,4 +209,108 @@ try {
 } catch(e) {
 	console.log(e);
 }
+```
+
+### getProfiles
+
+Returns a list of the backup profiles.
+The callback receives an array:
+```json
+	[{id, name}]
+```
+
+```js
+var akeeba = require('akeebabackup');
+var yoursite = new akeeba('http://www.example.com', 'yoursecretkey');
+
+try {
+	// yoursite.getProfiles(callback)
+	yoursite.getProfiles(function(data){
+		console.log(data);
+	});
+} catch(e) {
+	console.log(e);
+}
+```
+
+### getVersion
+
+Returns the version number of the API and the component.
+The callback receives an object:
+```json
+	{api, component, date, edition, updateinfo}
+```
+
+```js
+var akeeba = require('akeebabackup');
+var yoursite = new akeeba('http://www.example.com', 'yoursecretkey');
+
+try {
+	// yoursite.getVersion(callback)
+	yoursite.getVersion(function(data){
+		console.log(data);
+	});
+} catch(e) {
+	console.log(e);
+}
+```
+
+### listBackups
+
+Returns a (partial) list of the backup records known to the component. 
+The records are presented in reverse order, i.e. the first record is the last backup attempt, 
+whereas the last record is the earliest backup attempt known to the component.
+
+```js
+var akeeba = require('akeebabackup');
+var yoursite = new akeeba('http://www.example.com', 'yoursecretkey');
+
+try {
+	// yoursite.listBackups(callback, start, limit)
+	yoursite.listBackups(function(data){
+		console.log(data);
+	}, 0, 50);
+} catch(e) {
+	console.log(e);
+}
+```
+
+### update
+
+Triggers the entire akeeba update process
+
+```js
+var akeeba = require('akeebabackup');
+var yoursite = new akeeba('http://www.example.com', 'yoursecretkey');
+
+try {
+	yoursite.update();
+
+	yoursite.on('step', function(){
+		console.log('step completed');
+	});
+	yoursite.on('completed', function(){
+		console.log('update completed');
+	});
+} catch(e) {
+	console.log(e);
+}
+```
+
+### updateGetInformation
+
+Returns update status information, as returned by Live Update itself
+
+```js
+var akeeba = require('akeebabackup');
+var yoursite = new akeeba('http://www.example.com', 'yoursecretkey');
+
+try {
+	// yoursite.updateGetInformation(callback, force_fetch_new_data)
+	yoursite.updateGetInformation(function(data){
+		console.log(data);
+	}, true);
+} catch(e) {
+	console.log(e);
+}
 ```

index.js

@@ -411,18 +411,16 @@ AkeebaBackup.prototype.updateGetInformation = function(callback, force) {
 /**
  * Triggers the entire akeeba update process
  *
- * @fires   updated
- * @fires   update_download
- * @fires   update_extract
- * @fires   update_install
+ * @fires   step
+ * @fires   completed
  */
 AkeebaBackup.prototype.update = function() {
     var $this = this;
 
     this.updateDownload(function(){
         $this.updateExtract(function(){
             $this.updateInstall(function(data){
-                $this.emit('updated', data);
+                $this.emit('completed', data);
             });
         })
     });
@@ -433,7 +431,7 @@ AkeebaBackup.prototype.update = function() {
  *
  * @param  {Function} callback The callback called at the end of the download
  *
- * @fires   update_download
+ * @fires   step
  */
 AkeebaBackup.prototype.updateDownload = function(callback) {
 
@@ -442,7 +440,7 @@ AkeebaBackup.prototype.updateDownload = function(callback) {
     var json = this.getRequest('updateDownload');
 
     this.sendRequest(json, function (data) {
-        $this.emit('update_download', data);
+        $this.emit('step', data);
         callback(data);
     });
 }
@@ -452,7 +450,7 @@ AkeebaBackup.prototype.updateDownload = function(callback) {
  *
  * @param  {Function} callback The callback called at the end of the download
  *
- * @fires   update_extract
+ * @fires   step
  */
 AkeebaBackup.prototype.updateExtract = function(callback) {
 
@@ -461,7 +459,7 @@ AkeebaBackup.prototype.updateExtract = function(callback) {
     var json = this.getRequest('updateExtract');
 
     this.sendRequest(json, function (data) {
-        $this.emit('update_extract', data);
+        $this.emit('step', data);
         callback(data);
     });
 }
@@ -471,7 +469,7 @@ AkeebaBackup.prototype.updateExtract = function(callback) {
  *
  * @param  {Function} callback The callback called at the end of the download
  *
- * @fires   update_install
+ * @fires   step
  */
 AkeebaBackup.prototype.updateInstall = function(callback) {
 
@@ -480,7 +478,7 @@ AkeebaBackup.prototype.updateInstall = function(callback) {
     var json = this.getRequest('updateInstall');
 
     this.sendRequest(json, function (data) {
-        $this.emit('update_install', data);
+        $this.emit('step', data);
         callback(data);
     });
 }