From bd1e500e14b12658e3083118a55e1a549e4cf1fe Mon Sep 17 00:00:00 2001 From: Simon Prickett Date: Thu, 20 Jan 2022 16:54:36 +0000 Subject: [PATCH] Adds timeseries overview. (#1853) --- packages/time-series/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/time-series/README.md b/packages/time-series/README.md index b02e2648a5..5572fdb07e 100644 --- a/packages/time-series/README.md +++ b/packages/time-series/README.md @@ -1,3 +1,7 @@ # @node-redis/time-series -The sources and docs for this package are in the main [node-redis](https://github.com/redis/node-redis) repo. +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. + +To use these extra commands, your Redis server must have the RedisTimeSeries module installed. + +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.