Skip to content

Commit 0cd57cb

Browse files
committed
config quick start
1 parent 24ab148 commit 0cd57cb

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

config/index.html

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,7 @@
3232
<nav class="side scroll">
3333
<ul>
3434
<li><a href="#about">Avaje Config</a>
35-
<ul>
36-
<li><a href="#dependency">Dependency</a></li>
37-
</ul>
38-
</li>
35+
<li><a href="#quick">Quick Start</a></li>
3936
<li><a href="#eval">Expression evaluation</a></li>
4037
<li><a href="#startup">Startup</a></li>
4138
<li><a href="#loading">Loading configuration</a>
@@ -104,17 +101,29 @@ <h1 id="about">Avaje Config</h1>
104101
</table>
105102

106103
<p>&nbsp;</p>
107-
<h3 id="dependency">Dependency</h3>
108-
<div class="syntax xml"><div class="highlight"><pre><span></span><span class="nt">&lt;dependency&gt;</span>
104+
<h3 id="quick">Quick Start</h3>
105+
<h4>Add Dependency</h4>
106+
<div class="syntax xml"><div class="highlight"><pre><span></span><span class="nt">&lt;dependency&gt;</span>
109107
<span class="nt">&lt;groupId&gt;</span>io.avaje<span class="nt">&lt;/groupId&gt;</span>
110108
<span class="nt">&lt;artifactId&gt;</span>avaje-config<span class="nt">&lt;/artifactId&gt;</span>
111109
<span class="nt">&lt;version&gt;</span>&#36;{config-version}<span class="nt">&lt;/version&gt;</span>
112110
<span class="nt">&lt;/dependency&gt;</span>
113111
</pre></div>
114112
</div>
115113

114+
<h4>Add a <em>src/main/resources/application.properties</em> file (or yml)</h4>
115+
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">database</span><span class="o">.</span><span class="na field">example</span><span class="o">.</span><span class="na">username</span><span class="o">=</span><span class="n">notSecretUsername</span>
116+
<span class="n">database</span><span class="o">.</span><span class="na field">example</span><span class="o">.</span><span class="na">password</span><span class="o">=</span><span class="n">secretPassword</span>
117+
</pre></div>
118+
</div>
119+
120+
<h4>Retrieve properties with <em>Config.get</em></h4>
121+
122+
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">String</span> <span class="n">username</span> <span class="o">=</span> <span class="n">Config</span><span class="o">.</span><span class="na">get</span><span class="o">(</span><span class="s">&quot;database.example.username&quot;</span><span class="o">);</span>
123+
<span class="n">String</span> <span class="n">password</span> <span class="o">=</span> <span class="n">Config</span><span class="o">.</span><span class="na">get</span><span class="o">(</span><span class="s">&quot;database.example.password&quot;</span><span class="o">);</span>
124+
</pre></div>
125+
</div>
116126

117-
<p>&nbsp;</p>
118127
<h2 id="eval">Expression evaluation</h2>
119128
<p>
120129
Expressions start with <code>&dollar;{</code> end with <code>}</code>. They can optionally

0 commit comments

Comments
 (0)