README.adoc in runcom-8.5.0 vs README.adoc in runcom-8.6.0
- old
+ new
@@ -15,16 +15,17 @@
== Features
* Wraps the link:https://www.alchemists.io/projects/xdg[XDG] implementation which provides access to
the following environment variables:
-** `+$XDG_CACHE_HOME+`
-** `+$XDG_CONFIG_HOME+`
-** `+$XDG_CONFIG_DIRS+`
-** `+$XDG_DATA_HOME+`
-** `+$XDG_DATA_DIRS+`
-* Enhances the XDG cache, config, and data implementation. For the config, the following is
+** `$XDG_CACHE_HOME`
+** `$XDG_CONFIG_HOME`
+** `$XDG_CONFIG_DIRS`
+** `$XDG_DATA_HOME`
+** `$XDG_DATA_DIRS`
+** `$XDG_STATE_HOME`
+* Enhances the XDG cache, config, data, and state implementation. For the config, the following is
supported:
** Supports loading of CLI-specific http://yaml.org[YAML] configuration file.
** Supports loading and merging of nested/complex configurations.
** Supports hash representation of configuration.
@@ -61,9 +62,10 @@
[source,ruby]
----
cache = Runcom::Cache.new "example/data.json"
config = Runcom::Config.new "example/configuration.yml"
data = Runcom::Data.new "example/store.dat"
+state = Runcom::State.new "example/history.log"
----
Each of the above objects share the same API:
* `#relative` - Answers the relative path from which the object was constructed.