vocabulary: moving from 'plugin' to 'binding'

[src/app-framework-binder.git] / doc / afb-bindings-overview.md

diff --git a/doc/afb-plugins-overview.md b/doc/afb-bindings-overview.md
similarity index 69%
rename from doc/afb-plugins-overview.md
rename to doc/afb-bindings-overview.md
index dfbe601..03650cd 100644 (file)
--- a/doc/afb-plugins-overview.md
+++ b/doc/afb-bindings-overview.md
@@ -1,14 +1,14 @@
-Overview of plugins shipped with AFB-Daemon
+Overview of bindings shipped with AFB-Daemon
 ===========================================
     Version: 1
     Date:    09 juin 2016
     Author:  Manuel Bachmann
 
 
-List of plugins
+List of bindings
 ---------------
 
-Here are the plugins shipped in the source tree:
+Here are the bindings shipped in the source tree:
 
 * Hello World
 * Authentication
@@ -17,17 +17,17 @@ Here are the plugins shipped in the source tree:
 * Radio _(1 backend: RTLSDR RTL2832U)_
 * Media _(1 backend: Rygel UPnP)_
 
-All plugins may not be built, depending on the development libraries present on the system at build time.
+All bindings may not be built, depending on the development libraries present on the system at build time.
 
 
-Detail of plugins
+Detail of bindings
 -----------------
 
 ### Hello World
 
-A sample Hello World plugin for demonstration and learning purposes.
+A sample Hello World binding for demonstration and learning purposes.
 
-This plugin provides a few unauthenticated requests, all beginning with "ping", to demonstrate basic binder capabilities.
+This binding provides a few unauthenticated requests, all beginning with "ping", to demonstrate basic binder capabilities.
 
 **Verbs**:
 
@@ -43,9 +43,9 @@ This plugin provides a few unauthenticated requests, all beginning with "ping",
 
 ### Authentication
 
-An sample Authentication plugin for demonstration purposes.
+An sample Authentication binding for demonstration purposes.
 
-This plugin provides a few requests to demonstrate the binder's token-based security mechanism.
+This binding provides a few requests to demonstrate the binder's token-based security mechanism.
 
 Calling "_connect_" with a security token will initiate a session, calling "_refresh_" will issue a new token and invalidate the previous one, calling "_logout_" will invalidate all tokens and close the session.
 
@@ -62,9 +62,9 @@ Calling "_connect_" with a security token will initiate a session, calling "_ref
 
 ### Tic Tac Toe
 
-A sample Tic Tac Toe game plugin.
+A sample Tic Tac Toe game binding.
 
-This plugin provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response. 
+This binding provides an interactive Tic Tac Toe game where the binder returns the grid as a JSON response. 
 
 **Verbs**:
 
@@ -82,12 +82,12 @@ This plugin provides an interactive Tic Tac Toe game where the binder returns th
 
 ### Audio
 
-A sample Audio plugin with 2 backends:
+A sample Audio binding with 2 backends:
 
 * ALSA (mandatory)
 * PulseAudio (optional)
 
-This plugin is able to initialize a specific soundcard, define volume levels, channels (mono/stereo...), mute sound, and play a 22,050 Hz PCM stream.
+This binding is able to initialize a specific soundcard, define volume levels, channels (mono/stereo...), mute sound, and play a 22,050 Hz PCM stream.
 
 **Verbs**:
 
@@ -100,7 +100,7 @@ This plugin is able to initialize a specific soundcard, define volume levels, ch
 
 _(if PulseAudio development libraries are not found at build time, only ALSA will be available)_
 
-_(if a PulseAudio server is not found at runtime, the plugin will dynamically fall back to ALSA)_
+_(if a PulseAudio server is not found at runtime, the binding will dynamically fall back to ALSA)_
 
 _(a specifc backend can be forced by using this syntax before running afb-daemon : **$ export AFB_AUDIO_OUTPUT=Alsa**)_
 
@@ -109,11 +109,11 @@ _(a specifc backend can be forced by using this syntax before running afb-daemon
 
 ### Radio
 
-A sample AM/FM Radio plugin with 1 backend:
+A sample AM/FM Radio binding with 1 backend:
 
 * RTLSDR - Realtek RTL2832U dongles (mandatory)
 
-This plugin is able to initialize specific RTL2832U dongles, switch between AM/FM modes, define frequency, mute sound, and play sound (if combining with the **audio** plugin).
+This binding is able to initialize specific RTL2832U dongles, switch between AM/FM modes, define frequency, mute sound, and play sound (if combining with the **audio** binding).
 
 **Verbs**:
 
@@ -125,18 +125,18 @@ This plugin is able to initialize specific RTL2832U dongles, switch between AM/F
 * _mute_: sets device mute status (on-off)
 * _play_: sets device playing status (on-off)
 
-_(if rtlsdr development libraries are not found at build time, this plugin will not be built)_
+_(if rtlsdr development libraries are not found at build time, this binding will not be built)_
 
 <br />
 
 
 ### Media
 
-A sample Media Server plugin with 1 backend:
+A sample Media Server binding with 1 backend:
 
  * Rygel
 
-This plugin is able to detect a local Rygel UPnP media server, list audio files, select an audio file for playback, play/pause/seek in this file, upload an audio file to the server.
+This binding is able to detect a local Rygel UPnP media server, list audio files, select an audio file for playback, play/pause/seek in this file, upload an audio file to the server.
 
 **Verbs**:
 
@@ -150,7 +150,7 @@ This plugin is able to detect a local Rygel UPnP media server, list audio files,
 * _seek:_ seeks in the currently selected audio file, in seconds
 * _upload:_ uploads an audio file, with a POST request
 
-_(if GUPnP/GSSDP development libraries are not fund at build time, this plugin will not be built)_
+_(if GUPnP/GSSDP development libraries are not fund at build time, this binding will not be built)_
 
 <br />