Skip to content

Commit

Permalink
docs: README cleanup (redis#8)
Browse files Browse the repository at this point in the history
* --wip-- [skip ci]

* docs: add badges
  • Loading branch information
bsbodden committed Dec 19, 2021
1 parent 40a501e commit d1bcd71
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@

**Redis OM Spring** extends [Spring Data Redis](https://spring.io/projects/spring-data-redis) to take full advantage of the power of Redis.

**Redis OM Spring** | [Redis OM Node.js](https://github.com/redis/redis-om-node) | [Redis OM Python](https://github.com/redis/redis-om-python) | [Redis OM .NET](https://github.com/redis/redis-om-dotnet)
| Project Stage | Snapshot | Issues | | License |
| --- | --- | --- | --- | --- |
| [![Project stage][badge-Stage]][badge-stage-page] | [![Snapshots][badge-snapshots]][link-snapshots] | [![Percentage of issues still open][badge-open-issues]][open-issues] | [![Average time to resolve an issue][badge-issue-resolution]][issue-resolution] | [![License][license-image]][license-url] |

<details>
<summary><strong>Table of contents</strong></summary>
Expand All @@ -32,6 +34,7 @@
- [⛏️ Troubleshooting](#-troubleshooting)
- [✨ So, How Do You Get RediSearch and RedisJSON?](#-so-how-do-you-get-redisearch-and-redisjson)
- [❤️ Contributing](#-contributing)
- [🧑‍🤝‍🧑 Sibling Projects](#-sibling-projects)
- [📝 License](#-license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
Expand All @@ -57,6 +60,8 @@ This **preview** release provides all of SDRs capabilities plus:
* Full-text Search Indices via `@Searchable`
* `@Bloom` annotation to determine very fast, with and with high degree of certainty, whether a value is in a collection.

**Note:** Redis OM Spring currently works only with Jedis.

## 🏁 Getting Started

Here is a quick teaser of an application using Redis OM Spring to map a Spring Data model
Expand Down Expand Up @@ -279,13 +284,24 @@ We'd love your contributions!

You can also **contribute documentation** -- or just let us know if something needs more detail. [Open an issue on GitHub](https://github.com/redis-om/redis-om-spring/issues/new) to get started.

## 🧑‍🤝‍🧑 Sibling Projects

- [Redis OM Node.js](https://github.com/redis/redis-om-node)
- [Redis OM Python](https://github.com/redis/redis-om-python)
- [Redis OM .NET](https://github.com/redis/redis-om-dotnet)

## 📝 License

Redis OM uses the [BSD 3-Clause license][license-url].

<!-- Badges -->

[ci-url]: https://github.com/redis-developer/redis-om-spring/actions/workflows/ci.yml
[badge-stage]: https://img.shields.io/badge/Project%20Stage-Experimental-yellow.svg
[badge-stage-page]: https://github.com/redis/redis-om-spring/wiki/Project-Stages
[badge-snapshots]: https://img.shields.io/nexus/s/https/s01.oss.sonatype.org/com.redis.om/redis-om-spring.svg
[badge-open-issues]: http://isitmaintained.com/badge/open/redis/redis-om-spring.svg
[badge-issue-resolution]: http://isitmaintained.com/badge/resolution/redis/redis-om-spring.svg
[license-image]: http://img.shields.io/badge/license-BSD_3--Clause-green.svg?style=flat-square
[license-url]: LICENSE

Expand All @@ -299,4 +315,10 @@ Redis OM uses the [BSD 3-Clause license][license-url].
[redis-json-url]: https://oss.redis.com/redisjson/
[ulid-url]: https://github.com/ulid/spec
[redis-enterprise-url]: https://redis.com/try-free/
[link-snapshots]: https://s01.oss.sonatype.org/content/repositories/snapshots/com/redis/om/redis-om-spring/
[open-issues]: http://isitmaintained.com/project/redis/redis-om-spring
[issue-resolution]: http://isitmaintained.com/project/redis/redis-om-spring




0 comments on commit d1bcd71

Please sign in to comment.