You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+30-16
Original file line number
Diff line number
Diff line change
@@ -30,13 +30,14 @@ span
30
30
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
31
31
32
32
-[💡 Why Redis OM?](#-why-redis-om)
33
+
-[💻 Installation](#-installation)
34
+
-[🏁 Getting started](#-getting-started)
33
35
-[📇 Modeling Your Data](#-modeling-your-data)
34
36
-[✓ Validating Data With Your Model](#-validating-data-with-your-model)
35
37
-[🔎 Rich Queries and Embedded Models](#-rich-queries-and-embedded-models)
36
38
-[Querying](#querying)
37
39
-[Embedded Models](#embedded-models)
38
40
-[Calling Other Redis Commands](#calling-other-redis-commands)
39
-
-[💻 Installation](#-installation)
40
41
-[📚 Documentation](#-documentation)
41
42
-[⛏️ Troubleshooting](#️-troubleshooting)
42
43
-[✨ So How Do You Get RediSearch and RedisJSON?](#-so-how-do-you-get-redisearch-and-redisjson)
@@ -57,6 +58,31 @@ This **preview** release contains the following features:
57
58
* Declarative secondary-index generation
58
59
* Fluent APIs for querying Redis
59
60
61
+
## 💻 Installation
62
+
63
+
Installation is simple with `pip`, Poetry, or Pipenv.
64
+
65
+
```sh
66
+
# With pip
67
+
$ pip install redis-om
68
+
69
+
# Or, using Poetry
70
+
$ poetry add redis-om
71
+
```
72
+
73
+
## 🏁 Getting started
74
+
75
+
### Starting Redis
76
+
77
+
Before writing any code you'll need a Redis instance with the appropriate Redis modules! The quickest way to get this is with Docker:
78
+
79
+
```sh
80
+
docker run -p 6379:6379 -p 8001:8001 redis/redis-stack
81
+
```
82
+
83
+
This launches the [redis-stack](https://redis.io/docs/stack/) an extension of Redis that adds all manner of modern data structures to Redis. You'll also notice that if you open up http://localhost:8001 you'll have access to the redis-insight GUI, a GUI you can use to visualize and work with your data in Redis.
84
+
85
+
60
86
## 📇 Modeling Your Data
61
87
62
88
Redis OM contains powerful declarative models that give you data validation, serialization, and persistence to Redis.
0 commit comments