-
-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
196c1b1
commit c6667fc
Showing
1 changed file
with
31 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,47 @@ | ||
<!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
## Table of contents | ||
<div align="center"> | ||
<img src="https://res.cloudinary.com/adonisjs/image/upload/q_100/v1558612869/adonis-readme_zscycu.jpg" width="600px"> | ||
</div> | ||
|
||
- [@adonisjs/redis](#adonisjsredis) | ||
- [Change log](#change-log) | ||
- [Contributing](#contributing) | ||
- [Authors & License](#authors--license) | ||
# Adonis Redis | ||
> Redis provider for AdonisJs with support for multiple redis connections, cluster, pub/sub and much more. | ||
<!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
||
# @adonisjs/redis | ||
[![circleci-image]][circleci-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] | ||
|
||
[![circleci-image]][circleci-url] | ||
[![npm-image]][npm-url] | ||
![](https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript) | ||
This is a first party addon to add support for using Redis server with AdonisJs. In a nutshell: | ||
|
||
## Change log | ||
1. It allows having multiple redis connections by defining them inside `start/redis(.js|.ts)` file. | ||
2. Eases the API for pub/sub. | ||
3. Support for cluster and sentinel. | ||
|
||
The change log can be found in the [CHANGELOG.md](CHANGELOG.md) file. | ||
<!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
## Table of contents | ||
|
||
## Contributing | ||
- [Testing](#testing) | ||
- [Maintainers](#maintainers) | ||
|
||
Everyone is welcome to contribute. Please go through the following guides, before getting started. | ||
<!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
||
1. [Contributing](https://adonisjs.com/contributing) | ||
2. [Code of conduct](https://adonisjs.com/code-of-conduct) | ||
## Testing | ||
The tests are executed inside a Docker container, since setting up a redis cluster can be painful. Just make sure to have the Docker client running on your OS. | ||
|
||
Run the following commands to build and run tests. | ||
|
||
## Authors & License | ||
[thetutlage](https://github.com/thetutlage) and [contributors](https://github.com/adonisjs/adonis-redis/graphs/contributors). | ||
```sh | ||
docker-compose build | ||
docker-compose run --rm tests | ||
``` | ||
|
||
MIT License, see the included [MIT](LICENSE.md) file. | ||
## Maintainers | ||
[Harminder virk](https://github.com/thetutlage) | ||
|
||
[circleci-image]: https://img.shields.io/circleci/project/github/adonisjs/adonis-redis/master.svg?style=for-the-badge&logo=circleci | ||
[circleci-image]: https://img.shields.io/circleci/project/github/adonisjs/adonis-redis/master.svg?style=for-the-badge&logo=appveyor | ||
[circleci-url]: https://circleci.com/gh/adonisjs/adonis-redis "circleci" | ||
|
||
[npm-image]: https://img.shields.io/npm/v/@adonisjs/redis.svg?style=for-the-badge&logo=npm | ||
[npm-url]: https://npmjs.org/package/@adonisjs/redis "npm" | ||
|
||
[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript | ||
|
||
[license-url]: LICENSE.md | ||
[license-image]: https://img.shields.io/aur/license/pac.svg?style=for-the-badge |