Skip to content

Commit

Permalink
docs: add examples section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
bsbodden committed Nov 7, 2021
1 parent 1089762 commit a452c73
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,17 @@ Add the Maven dependency:

The Redis OM documentation is available [here](docs/index.md).

## Demos

### Basic JSON Mapping and Querying

- **rds-documents**:
- Simple API example of `@Document` mapping, Spring Repositories and Querying.
- Run with `./mvnw install -Dmaven.test.skip && ./mvnw spring-boot:run -pl demos/rds-documents`
- **rds-hashes**:
- Simple API example of `@RedisHash`, enhanced secondary indices and querying.
- Run with `./mvnw install -Dmaven.test.skip && ./mvnw spring-boot:run -pl demos/rds-hashes`

## ⛏️ Troubleshooting

If you run into trouble or have any questions, we're here to help!
Expand Down

0 comments on commit a452c73

Please sign in to comment.