mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Add the Weather 'apiKey' config value to the documentation
This commit is contained in:
parent
35c2e088e0
commit
d3f4812ad8
@ -17,8 +17,11 @@ wtf/weather/
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
|
||||
|
||||
<span class="caption">Key:</span> `WTF_OWM_API_KEY` <br />
|
||||
<span class="caption">Action:</span> Your <a href="https://openweathermap.org/appid">OpenWeatherMap API</a> key.
|
||||
<span class="caption">Action:</span> Your <a href="https://openweathermap.org/appid">OpenWeatherMap API</a> key. <br />
|
||||
<span class="caption">Note:</span> DEPRECATED. See the `apiKey` config value, below.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
@ -41,6 +44,7 @@ wtf/weather/
|
||||
|
||||
```yaml
|
||||
weather:
|
||||
apiKey: "2dfb3e3650a1950adddb6badf5ba1aaa"
|
||||
# From http://openweathermap.org/help/city_list.txt
|
||||
cityids:
|
||||
- 6173331
|
||||
@ -62,6 +66,9 @@ weather:
|
||||
|
||||
### Attributes
|
||||
|
||||
`apiKey` <br />
|
||||
Your <a href="https://openweathermap.org/appid">OpenWeatherMap API</a> key.
|
||||
|
||||
`cityids` <br />
|
||||
A list of the <a
|
||||
href="http://openweathermap.org/help/city_list.txt">OpenWeatherMap city
|
||||
|
@ -380,12 +380,11 @@ Key: h Action: Show the previous git repository.</description>
|
||||
|
||||
<guid>https://wtfutil.com/posts/modules/weather/</guid>
|
||||
<description>Displays a configurable list of current weather report, including current temperature, sunrise time, and sunset time.
|
||||
Source Code wtf/weather/ Required ENV Variables Key: WTF_OWM_API_KEY Action: Your OpenWeatherMap API key.
|
||||
Source Code wtf/weather/ Required ENV Variables Key: WTF_OWM_API_KEY Action: Your OpenWeatherMap API key. Note: DEPRECATED. See the apiKey config value, below.
|
||||
Keyboard Commands Key: / Action: Open/close the widget&rsquo;s help window.
|
||||
Key: h Action: Show the previous weather location.
|
||||
Key: l Action: Show the next weather location.
|
||||
Key: ← Action: Show the previous weather location.
|
||||
Key: → Action: Show the next weather location.</description>
|
||||
Key: ← Action: Show the previous weather location.</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
|
@ -380,12 +380,11 @@ Key: h Action: Show the previous git repository.</description>
|
||||
|
||||
<guid>https://wtfutil.com/posts/modules/weather/</guid>
|
||||
<description>Displays a configurable list of current weather report, including current temperature, sunrise time, and sunset time.
|
||||
Source Code wtf/weather/ Required ENV Variables Key: WTF_OWM_API_KEY Action: Your OpenWeatherMap API key.
|
||||
Source Code wtf/weather/ Required ENV Variables Key: WTF_OWM_API_KEY Action: Your OpenWeatherMap API key. Note: DEPRECATED. See the apiKey config value, below.
|
||||
Keyboard Commands Key: / Action: Open/close the widget&rsquo;s help window.
|
||||
Key: h Action: Show the previous weather location.
|
||||
Key: l Action: Show the next weather location.
|
||||
Key: ← Action: Show the previous weather location.
|
||||
Key: → Action: Show the next weather location.</description>
|
||||
Key: ← Action: Show the previous weather location.</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
|
@ -156,11 +156,7 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
|
||||
<span class="caption">Action:</span> Show the previous project.</p>
|
||||
|
||||
<p><span class="caption">Key:</span> <code>←</code> <br />
|
||||
<<<<<<< HEAD
|
||||
<span class="caption">Action:</span←> Show the previous project.</p>
|
||||
=======
|
||||
<span class="caption">Action:</span> Show the previous project.</p>
|
||||
>>>>>>> baustinanki-make-jira-interactable
|
||||
|
||||
<p><span class="caption">Key:</span> <code>l</code> <br />
|
||||
<span class="caption">Action:</span> Show the next project.</p>
|
||||
|
@ -145,7 +145,8 @@ current temperature, sunrise time, and sunset time.</p>
|
||||
<h2 id="required-env-variables">Required ENV Variables</h2>
|
||||
|
||||
<p><span class="caption">Key:</span> <code>WTF_OWM_API_KEY</code> <br />
|
||||
<span class="caption">Action:</span> Your <a href="https://openweathermap.org/appid">OpenWeatherMap API</a> key.</p>
|
||||
<span class="caption">Action:</span> Your <a href="https://openweathermap.org/appid">OpenWeatherMap API</a> key. <br />
|
||||
<span class="caption">Note:</span> DEPRECATED. See the <code>apiKey</code> config value, below.</p>
|
||||
|
||||
<h2 id="keyboard-commands">Keyboard Commands</h2>
|
||||
|
||||
@ -166,6 +167,7 @@ current temperature, sunrise time, and sunset time.</p>
|
||||
|
||||
<h2 id="configuration">Configuration</h2>
|
||||
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">weather<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>apiKey<span class="p">:</span><span class="w"> </span><span class="s2">"2dfb3e3650a1950adddb6badf5ba1aaa"</span><span class="w">
|
||||
</span><span class="w"> </span><span class="c"># From http://openweathermap.org/help/city_list.txt</span><span class="w">
|
||||
</span><span class="w"> </span>cityids<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>-<span class="w"> </span><span class="m">6173331</span><span class="w">
|
||||
@ -185,6 +187,9 @@ current temperature, sunrise time, and sunset time.</p>
|
||||
</span><span class="w"> </span>tempUnit<span class="p">:</span><span class="w"> </span><span class="s2">"C"</span></code></pre></div>
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<p><code>apiKey</code> <br />
|
||||
Your <a href="https://openweathermap.org/appid">OpenWeatherMap API</a> key.</p>
|
||||
|
||||
<p><code>cityids</code> <br />
|
||||
A list of the <a
|
||||
href="http://openweathermap.org/help/city_list.txt">OpenWeatherMap city
|
||||
|
Loading…
x
Reference in New Issue
Block a user