Skip to content

Commit bd1e500

Browse files
author
Simon Prickett
authored
Adds timeseries overview. (#1853)
1 parent 41f6b00 commit bd1e500

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

packages/time-series/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# @node-redis/time-series
22

3-
The sources and docs for this package are in the main [node-redis](https://github.com/redis/node-redis) repo.
3+
This package provides support for the [RedisTimeSeries](https://redistimeseries.io) module, which adds a time series data structure to Redis. It extends the [Node Redis client](https://github.com/redis/node-redis) to include functions for each of the RedisTimeSeries commands.
4+
5+
To use these extra commands, your Redis server must have the RedisTimeSeries module installed.
6+
7+
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 `time-series.js` in the Node Redis examples folder.

0 commit comments

Comments
 (0)