Skip to content

Commit fd170e5

Browse files
update readme
1 parent 59c9cfe commit fd170e5

1 file changed

Lines changed: 29 additions & 2 deletions

File tree

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,43 @@
1313
</p> -->
1414
</div>
1515

16+
- [🚦 Current Status](#-current-status)
17+
- [🛑 Foreword](#-foreword)
18+
- [✨ Features](#-features)
19+
- [🤔 Motivation](#-motivation)
20+
- [🖐 Requirements](#-requirements)
21+
- [⏳ Installation](#-installation)
22+
- [🔧 Configuration](#-configuration)
23+
- [Single Redis Node - with Redlock](#single-redis-node---with-redlock)
24+
- [🚚 Usage and API](#-usage-and-api)
25+
- [Config](#config)
26+
- [Connections](#connections)
27+
- [Redis Client](#redis-client)
28+
- [Redlock Instance](#redlock-instance)
29+
- [Contributing](#contributing)
30+
- [License](#license)
31+
1632
## 🚦 Current Status
1733

1834
This package is currently under development and should be consider **ALPHA** in terms of state. I/We are currently accepting contributions and/or dedicated contributors to help develop and maintain this package.
1935

20-
If interested please feel free to email the lead maintainer Derrick at: derrickmehaffy@gmail.com
36+
If interested please feel free to email the lead maintainer Derrick at: derrickmehaffy@gmail.com or ping `DMehaffy#1337` on Discord.
2137

2238
## 🛑 Foreword
2339

24-
This package's lead maintainer is an employee of Strapi however this package is not officially maintained by Strapi Solutions SAS nor Strapi, Inc. and is currently maintained in the free time of the lead maintainer. **Absolutely no part of this code should be considered covered under any agreement you have with Strapi proper** including but not limited to any Enterprise Agreement you have with Strapi.
40+
This package's lead maintainer is an employee of Strapi however this package is not officially maintained by Strapi Solutions SAS nor Strapi, Inc. and is currently maintained in the free time of the lead maintainer.
41+
42+
**Absolutely no part of this code should be considered covered under any agreement you have with Strapi proper** including but not limited to any Enterprise Agreement you have with Strapi.
2543

2644
## ✨ Features
2745

46+
This plugin utilizes 2 core packages:
47+
48+
- [ioredis](https://github.com/luin/ioredis) - for all connection management
49+
- [node-redlock](https://github.com/mike-marcacci/node-redlock) - as a feature for providing cluster aware support to Strapi packages
50+
51+
These are the primary features that are finished or currently being worked on:
52+
2853
- [x] Redis Single Node Support
2954
- [ ] Redis Cluster Mode Support
3055
- [ ] Redis Sharding Support
@@ -143,6 +168,8 @@ I/We are actively looking for contributors, maintainers, and others to help shap
143168

144169
Instead of reinventing the wheel every time you need to connect to Redis, the hope is to centralize the connections in a single plugin that all plugins can piggy back on.
145170

171+
If interested please feel free to email the lead maintainer Derrick at: derrickmehaffy@gmail.com or ping `DMehaffy#1337` on Discord.
172+
146173
## License
147174

148175
See the [LICENSE](./LICENSE.md) file for licensing information.

0 commit comments

Comments
 (0)