hermes-server - npm Package Compare versions

Comparing version 0.2.1 to 0.3.0

index.js

 module.exports = {
   Server: require('./hermes'),
   Route: require('./route'),
+  RouteSupplier: require('./route-supplier'),
   FileSystemRouteSupplier: require('./route-suppliers/file-system-route-supplier'),
   SimpleRouteSupplier: require('./route-suppliers/simple-route-supplier')
 };

package.json

 {
   "name": "hermes-server",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "repository": "JakeElder/hermes",
   "author": "Jake Elder <[e-mail]>",
   "license": "ISC",
+  "description": "End point aggregation server. Useful for providing a single url for all of your micro service endpoints.",
   "dependencies": {
@@ -8,0 +9,0 @@ "express": "^4.13.3",

README.md

 Hermes
 ======
-End point aggregation server. Useful for providing a single url for all of your
+End point aggregation server. useful for providing a single url for all of your
 micro service endpoints.
@@ -31,3 +31,3 @@
 In order to know where to proxy traffic, Hermes needs to be provided with a
-set of routes. This is achieved by instantiating a routeProvider.
+set of routes. This is achieved by instantiating a RouteSupplier.
 
@@ -65,2 +65,24 @@ ### Default Route Suppliers
 
+### Custom Route Suppliers
+To allow custom generation/retrieval of routes, it is possible to create your
+own RouteSupplier
+```javascript
+const Q = require('q');
+const Route = require('Hermes').Route;
+
+class MyRouteSupplier extends Hermes.RouteSupplier {
+  constructor(options) {
+    super(options);
+  }
+
+  getRoutes() {
+    return Q.promise((resolve) => {
+      fetchRoutesFromSomeService().then((routes) => {
+          resolve(routes.map(data => new Route(data)));
+      });
+    });
+  }
+}
+```
+
 Route Format
@@ -67,0 +89,0 @@ ------------

No alert changes

Improved metrics

Total package byte prevSize

19058

increased by3.62%

Lines of code

303

increased by0.33%

Number of lines in readme file

110

increased by25%

No dependency changes