Skip to content

Commit 98ff03c

Browse files
author
matmoncon
committed
docs: update docs
1 parent 6af210d commit 98ff03c

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@
77

88
`pyneo4j-ogm` is a asynchronous `Object-Graph-Mapper` for [`Neo4j 5+`](https://neo4j.com/docs/) and [`Python 3.10+`](https://www.python.org/). It is inspired by [`beanie`](https://github.com/roman-right/beanie) and build on top of proven technologies like [`Pydantic 1.10+ and 2+`](https://docs.pydantic.dev/latest/) and the [`Neo4j Python Driver`](https://neo4j.com/docs/api/python-driver/current/index.html). It saves you from writing ever-repeating boilerplate queries and allows you to focus on the `stuff that actually matters`. It is designed to be simple and easy to use, but also flexible and powerful.
99

10+
## 🔥 Hot topics for the future
11+
12+
You never know what the future might hold. But these things are happening for sure (not necessarily in this order):
13+
14+
- [ ] Add documentation for migrations
15+
- [x] Improving the current test coverage
16+
- [ ] More/Better examples for simple and advanced use-cases
17+
- [ ] Complete documentation overhaul
18+
1019
## 🎯 Features <a name="features"></a>
1120

1221
- [x] **Simple and easy to use**: pyneo4j-ogm is designed to be `simple and easy to use`, while also providing a solid foundation for some more `advanced use-cases`.
@@ -274,6 +283,7 @@ In the following we are going to take a closer look at the different parts of `p
274283
### Table of contents
275284

276285
- [Pyneo4j-OGM](#pyneo4j-ogm)
286+
- [🔥 Hot topics for the future](#-hot-topics-for-the-future)
277287
- [🎯 Features ](#-features-)
278288
- [📦 Installation ](#-installation-)
279289
- [🚀 Quickstart ](#-quickstart-)

0 commit comments

Comments
 (0)