Remove iron...

This commit is contained in:
Travis Reeder
2017-05-18 18:59:34 +00:00
committed by Reed Allman
parent 521df8c1ff
commit 9cc12b4b12
146 changed files with 406 additions and 1050 deletions

View File

@@ -1,16 +1,16 @@
# Extending IronFunctions
# Extending Oracle Functions
IronFunctions is extensible so you can add custom functionality and extend the project without needing to modify the core.
Oracle Functions is extensible so you can add custom functionality and extend the project without needing to modify the core.
There are multiple ways to extend the functionality of IronFunctions.
There are multiple ways to extend the functionality of Oracle Functions.
1. Listeners - listen to API events such as a route getting updated and react accordingly.
1. Middleware - a chain of middleware is executed before an API handler is called.
1. Add API Endpoints - extend the default IronFunctions API.
1. Add API Endpoints - extend the default Oracle Functions API.
## Listeners
Listeners are the main way to extend IronFunctions.
Listeners are the main way to extend Oracle Functions.
The following listener types are supported:
@@ -19,7 +19,7 @@ The following listener types are supported:
### Creating a Listener
You can easily use app and runner listeners by creating a struct with valid methods satisfying the interface for the respective listener and adding it to the IronFunctions API
You can easily use app and runner listeners by creating a struct with valid methods satisfying the interface for the respective listener and adding it to the Oracle Functions API
Example:
@@ -67,6 +67,6 @@ See examples of this in [examples/middleware/main.go](../../examples/middleware/
## Adding API Endpoints
You can add API endpoints to the IronFunctions server by using the `AddEndpoint` and `AddEndpointFunc` methods.
You can add API endpoints to the Oracle Functions server by using the `AddEndpoint` and `AddEndpointFunc` methods.
See examples of this in [examples/extensions/main.go](../../examples/extensions/main.go).