-
-
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
b58dc73
commit c479ccf
Showing
1 changed file
with
35 additions
and
42 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,53 +1,46 @@ | ||
<div align="center"> | ||
<img src="https://res.cloudinary.com/adonisjs/image/upload/q_100/v1558612869/adonis-readme_zscycu.jpg" width="600px"> | ||
</div> | ||
# @adonisjs/redis | ||
|
||
<br /> | ||
|
||
<div align="center"> | ||
<h3>Redis</h3> | ||
<p>Redis provider for AdonisJS with support for multiple <strong>Redis connections</strong>, <strong>cluster</strong>, <strong>pub/sub</strong> and much more</p> | ||
</div> | ||
[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url] [![snyk-image]][snyk-url] | ||
|
||
<br /> | ||
## Introduction | ||
Redis provider for AdonisJS with support for multiple Redis connections, cluster, pub/sub and much more | ||
|
||
<div align="center"> | ||
|
||
[![gh-workflow-image]][gh-workflow-url] [![typescript-image]][typescript-url] [![npm-image]][npm-url] [![license-image]][license-url] [![synk-image]][synk-url] | ||
|
||
</div> | ||
|
||
<div align="center"> | ||
<h3> | ||
<a href="https://adonisjs.com"> | ||
Website | ||
</a> | ||
<span> | </span> | ||
<a href="https://docs.adonisjs.com/guides/redis"> | ||
Guides | ||
</a> | ||
<span> | </span> | ||
<a href="CONTRIBUTING.md"> | ||
Contributing | ||
</a> | ||
</h3> | ||
</div> | ||
|
||
<div align="center"> | ||
<sub>Built with ❤︎ by <a href="https://twitter.com/AmanVirk1">Harminder Virk</a> | ||
</div> | ||
|
||
[gh-workflow-image]: https://img.shields.io/github/workflow/status/adonisjs/redis/test?style=for-the-badge | ||
[gh-workflow-url]: https://github.com/adonisjs/redis/actions/workflows/test.yml "Github action" | ||
## Official Documentation | ||
The documentation is available on the [AdonisJS website](https://docs.adonisjs.com/guides/repl) | ||
|
||
[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript | ||
[typescript-url]: "typescript" | ||
## Contributing | ||
One of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework. | ||
|
||
We encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework. | ||
|
||
### Run tests locally | ||
Easiest way to run tests is to launch the redis cluster using docker-compose and `docker-compose.yml` file. | ||
|
||
```sh | ||
docker-compose up -d | ||
npm run test | ||
``` | ||
|
||
We also have a `docker-compose.ci.yml` file that will dockerize the library and run tests inside the container. This is what we use on Github actions. | ||
|
||
## Code of Conduct | ||
In order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md). | ||
|
||
## License | ||
AdonisJS Redis is open-sourced software licensed under the [MIT license](LICENSE.md). | ||
|
||
[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/redis/test.yml?style=for-the-badge | ||
[gh-workflow-url]: https://github.com/adonisjs/redis/actions/workflows/test.yml "Github action" | ||
|
||
[npm-image]: https://img.shields.io/npm/v/@adonisjs/redis/latest.svg?style=for-the-badge&logo=npm | ||
[npm-url]: https://www.npmjs.com/package/@adonisjs/redis/v/latest "npm" | ||
|
||
[license-image]: https://img.shields.io/npm/l/@adonisjs/redis?color=blueviolet&style=for-the-badge | ||
[license-url]: LICENSE.md "license" | ||
[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/github/license/adonisjs/redis?style=for-the-badge | ||
|
||
[synk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs/redis?label=Synk%20Vulnerabilities&style=for-the-badge | ||
[synk-url]: https://snyk.io/test/github/adonisjs/redis?targetFile=package.json "synk" | ||
[snyk-image]: https://img.shields.io/snyk/vulnerabilities/github/adonisjs/redis?label=Snyk%20Vulnerabilities&style=for-the-badge | ||
[snyk-url]: https://snyk.io/test/github/adonisjs/redis?targetFile=package.json "snyk" |