|
32 | 32 | <nav class="side scroll">
|
33 | 33 | <ul>
|
34 | 34 | <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> |
39 | 36 | <li><a href="#eval">Expression evaluation</a></li>
|
40 | 37 | <li><a href="#startup">Startup</a></li>
|
41 | 38 | <li><a href="#loading">Loading configuration</a>
|
@@ -104,17 +101,29 @@ <h1 id="about">Avaje Config</h1>
|
104 | 101 | </table>
|
105 | 102 |
|
106 | 103 | <p> </p>
|
107 |
| - <h3 id="dependency">Dependency</h3> |
108 |
| -<div class="syntax xml"><div class="highlight"><pre><span></span><span class="nt"><dependency></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"><dependency></span> |
109 | 107 | <span class="nt"><groupId></span>io.avaje<span class="nt"></groupId></span>
|
110 | 108 | <span class="nt"><artifactId></span>avaje-config<span class="nt"></artifactId></span>
|
111 | 109 | <span class="nt"><version></span>${config-version}<span class="nt"></version></span>
|
112 | 110 | <span class="nt"></dependency></span>
|
113 | 111 | </pre></div>
|
114 | 112 | </div>
|
115 | 113 |
|
| 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">"database.example.username"</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">"database.example.password"</span><span class="o">);</span> |
| 124 | +</pre></div> |
| 125 | +</div> |
116 | 126 |
|
117 |
| - <p> </p> |
118 | 127 | <h2 id="eval">Expression evaluation</h2>
|
119 | 128 | <p>
|
120 | 129 | Expressions start with <code>${</code> end with <code>}</code>. They can optionally
|
|
0 commit comments