Merge pull request #34 from koopjs/p/route-prefix-option

Document routePrefix registration option.

Author: rgwozdz

docs/setup.md

@@ -58,6 +58,12 @@ Once you've got a development environment, an Express server, and a database, al
 
 `koop.register(provider)`
 
+With Koop 3.10.0 and higher, you can add a prefix to all routes for a specific provider at registration time. For example:
+
+`koop.register(provider, { routePrefix: '/api/v1})`  
+
+Adding the above option will prepend `/api/v1` to all of a provider's custom routes as well as the routes generated by any registered output plugins.
+
 ## 4. Start the server!
 
 If you've got everything set up properly, you should be able to start the server! Add a script to you package.json like the example below that points to your server file and type `npm start`.

docs/setup/index.html

@@ -96,6 +96,9 @@ <h2>2. Express server</h2>
 <h2>3. Providers</h2>
 <p>Once you&#x2019;ve got a development environment, an Express server, and a database, all you need to do is configure your providers! See the complete <a href="../docs/providers/">list of providers</a> for further instructions.</p>
 <p><code>koop.register(provider)</code></p>
+<p>With Koop 3.10.0 and higher, you can add a prefix to all routes for a specific provider at registration time. For example:</p>
+<p><code>koop.register(provider, { routePrefix: &apos;/api/v1})</code></p>
+<p>Adding the above option will prepend <code>/api/v1</code> to all of a provider&#x2019;s custom routes as well as the routes generated by any registered output plugins.</p>
 <h2>4. Start the server!</h2>
 <p>If you&#x2019;ve got everything set up properly, you should be able to start the server! Add a script to you package.json like the example below that points to your server file and type <code>npm start</code>.</p>
 <script src="https://gist.github.com/dmfenton/114c09b3befd8e60b3a30ff5f65d8c82.js"></script>