diff --git a/config/src/main/java/com/typesafe/config/Config.java b/config/src/main/java/com/typesafe/config/Config.java index e53b0849..27fb26e0 100644 --- a/config/src/main/java/com/typesafe/config/Config.java +++ b/config/src/main/java/com/typesafe/config/Config.java @@ -66,6 +66,12 @@ import java.util.Set; * can use {@link #entrySet()} which recurses the object tree for you and builds * up a <code>Set</code> of all path-value pairs where the value is not null. * + * <p> You can find an example app and library <a + * href="https://github.com/typesafehub/config/tree/master/examples">on + * GitHub</a>. Also be sure to read the package overview + * ({@link com.typesafe.config}) which describes the big picture as shown + * in those examples. + * * <p> * <em>Do not implement {@code Config}</em>; it should only be implemented by * the config library. Arbitrary implementations will not work because the diff --git a/config/src/main/java/com/typesafe/config/ConfigFactory.java b/config/src/main/java/com/typesafe/config/ConfigFactory.java index e713a4bb..b7ed4dc6 100644 --- a/config/src/main/java/com/typesafe/config/ConfigFactory.java +++ b/config/src/main/java/com/typesafe/config/ConfigFactory.java @@ -27,6 +27,12 @@ import com.typesafe.config.impl.Parseable; * operation potentially parsing multiple resources and resolving substitutions, * while the ones with "parse" in the name just create a {@link ConfigValue} * from a resource and nothing else. + * + * <p> You can find an example app and library <a + * href="https://github.com/typesafehub/config/tree/master/examples">on + * GitHub</a>. Also be sure to read the package overview + * ({@link com.typesafe.config}) which describes the big picture as shown + * in those examples. */ public final class ConfigFactory { private ConfigFactory() {