Updates

documentation/time-series/index.html

@@ -2,5 +2,7 @@
 <a href="#node-redistime-series" id="node-redistime-series" style="color: inherit; text-decoration: none;">
   <h1>@node-redis/time-series</h1>
 </a>
-<p>The sources and docs for this package are in the main <a href="https://github.com/redis/node-redis">node-redis</a> repo.</p>
+<p>This package provides support for the <a href="https://redistimeseries.io">RedisTimeSeries</a> module, which adds a time series data structure to Redis. It extends the <a href="https://github.com/redis/node-redis">Node Redis client</a> to include functions for each of the RedisTimeSeries commands.</p>
+<p>To use these extra commands, your Redis server must have the RedisTimeSeries module installed.</p>
+<p>For an example of how to add values to a time series, query a time series, and perform aggregated queries against a time series, see <code>time-series.js</code> in the Node Redis examples folder.</p>
 </div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="modules/commands.html">commands</a></li><li class=" tsd-kind-module"><a href="modules/commands_ADD.html">commands/ADD</a></li><li class=" tsd-kind-module"><a href="modules/commands_ALTER.html">commands/ALTER</a></li><li class=" tsd-kind-module"><a href="modules/commands_CREATE.html">commands/CREATE</a></li><li class=" tsd-kind-module"><a href="modules/commands_CREATERULE.html">commands/CREATERULE</a></li><li class=" tsd-kind-module"><a href="modules/commands_DECRBY.html">commands/DECRBY</a></li><li class=" tsd-kind-module"><a href="modules/commands_DEL.html">commands/DEL</a></li><li class=" tsd-kind-module"><a href="modules/commands_DELETERULE.html">commands/DELETERULE</a></li><li class=" tsd-kind-module"><a href="modules/commands_GET.html">commands/GET</a></li><li class=" tsd-kind-module"><a href="modules/commands_INCRBY.html">commands/INCRBY</a></li><li class=" tsd-kind-module"><a href="modules/commands_INFO.html">commands/INFO</a></li><li class=" tsd-kind-module"><a href="modules/commands_INFO_DEBUG.html">commands/INFO_<wbr/>DEBUG</a></li><li class=" tsd-kind-module"><a href="modules/commands_MADD.html">commands/MADD</a></li><li class=" tsd-kind-module"><a href="modules/commands_MGET.html">commands/MGET</a></li><li class=" tsd-kind-module"><a href="modules/commands_MGET_WITHLABELS.html">commands/MGET_<wbr/>WITHLABELS</a></li><li class=" tsd-kind-module"><a href="modules/commands_MRANGE.html">commands/MRANGE</a></li><li class=" tsd-kind-module"><a href="modules/commands_MRANGE_WITHLABELS.html">commands/MRANGE_<wbr/>WITHLABELS</a></li><li class=" tsd-kind-module"><a href="modules/commands_MREVRANGE.html">commands/MREVRANGE</a></li><li class=" tsd-kind-module"><a href="modules/commands_MREVRANGE_WITHLABELS.html">commands/MREVRANGE_<wbr/>WITHLABELS</a></li><li class=" tsd-kind-module"><a href="modules/commands_QUERYINDEX.html">commands/QUERYINDEX</a></li><li class=" tsd-kind-module"><a href="modules/commands_RANGE.html">commands/RANGE</a></li><li class=" tsd-kind-module"><a href="modules/commands_REVRANGE.html">commands/REVRANGE</a></li><li class=" tsd-kind-module"><a href="modules/index.html">index</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>