=== Yaml Configuration Format

The Yaml Configuration Format extends the Vert.x Configuration Retriever and provides the
support for the Yaml Configuration Format format.

==== Using the Yaml Configuration Format

To use the Yaml Configuration Format, add the following dependency to the
_dependencies_ section of your build descriptor:

* Maven (in your `pom.xml`):

[source,xml,subs="+attributes"]
----
<dependency>
  <groupId>io.vertx</groupId>
  <artifactId>vertx-config-yaml</artifactId>
  <version>3.4.1</version>
</dependency>
<dependency>
  <groupId>io.vertx</groupId>
  <artifactId>vertx-config</artifactId>
  <version>3.4.1</version>
</dependency>
----

* Gradle (in your `build.gradle` file):

[source,groovy,subs="+attributes"]
----
compile 'io.vertx:vertx-config:3.4.1'
compile 'io.vertx:vertx-config-yaml:3.4.1'
----

==== Configuring the store to use YAML

Once added to your classpath or dependencies, you need to configure the
`link:../../yardoc/VertxConfig/ConfigRetriever.html[ConfigRetriever]` to use this format:

[source, ruby]
----
require 'vertx-config/config_retriever'
store = {
  'type' => "file",
  'format' => "yaml",
  'config' => {
    'path' => "my-config.yaml"
  }
}

retriever = VertxConfig::ConfigRetriever.create(vertx, {
  'stores' => [
    store
  ]
})

----

You just need to set `format` to `yaml`.