Update README (#288)

* Update README * update readme * add anchor * update docs * update changelog --------- Co-authored-by: katarinasupe <[email protected]>
memgraph · Oct 3, 2023 · eb6d690 · eb6d690
1 parent a616731
commit eb6d690
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -15,15 +15,24 @@ An Object Graph Mapper or OGM provides a developer-friendly workflow that allows
 
 ## Installation
 
-To install GQLAlchemy, you will need the following:
+### Prerequisites
 
 - **Python 3.8 - 3.11**
-- `pymgclient` [build prerequisites](https://memgraph.github.io/pymgclient/introduction.html#build-prerequisites): GQLAlchemy is built on top of Memgraph's low-level Python client `pymgclient`
+- [`pymgclient`](https://github.com/memgraph/pymgclient):
+
+  - Install `pymgclient` [build prerequisites](https://memgraph.github.io/pymgclient/introduction.html#build-prerequisites)
+  - Install `pymgclient` via pip:
+
+  ```bash
+  pip install --user pymgclient
+  ```
 
 > [!WARNING]  
 > Python 3.11 users: On Windows, GQLAlchemy is not yet compatible with this Python version. Linux users can install GQLAlchemy **without** the DGL extra (due to its dependencies not supporting Python 3.11 yet). If this is currently a blocker for you, please let us know by [opening an issue](https://github.com/memgraph/gqlalchemy/issues).
 
-After you’ve installed the prerequisites, run the following command to install
+### Install GQLAlchemy
+
+After you’ve installed the [prerequisites](#prerequisites), run the following command to install
 GQLAlchemy:
 
 ```bash
@@ -42,17 +51,17 @@ pip install gqlalchemy[docker] # Docker support
 pip install gqlalchemy[all] # All of the above
 ```
 
-If you are using the zsh terminal, surround `gqlalchemy[$extras]` with quotes:
+If you intend to use GQLAlchemy with PyTorch Geometric support, that library must be installed manually:
 
 ```bash
-pip install 'gqlalchemy[arrow]'
+pip install gqlalchemy[torch_pyg] # prerequisite
+pip install torch-scatter torch-sparse torch-cluster torch-spline-conv torch-geometric -f https://data.pyg.org/whl/torch-1.13.0+cpu.html"
 ```
 
-If you intend to use GQLAlchemy with PyTorch Geometric support, that library must be installed manually:
+If you are using the zsh terminal, surround `gqlalchemy[$extras]` with quotes:
 
 ```bash
-pip install gqlalchemy[torch_pyg] # prerequisite
-pip install torch-scatter torch-sparse torch-cluster torch-spline-conv torch-geometric -f https://data.pyg.org/whl/torch-1.13.0+cpu.html"
+pip install 'gqlalchemy[arrow]'
 ```
 
 If you are using [Conda](https://docs.conda.io/en/latest/) for Python environment management, you can install GQLAlchemy through pip.
@@ -123,7 +132,7 @@ mkdocs serve
 
 ## License
 
-Copyright (c) 2016-2022 [Memgraph Ltd.](https://memgraph.com)
+Copyright (c) 2016-2023 [Memgraph Ltd.](https://memgraph.com)
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 this file except in compliance with the License. You may obtain a copy of the

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -22,7 +22,7 @@
 **Special thanks to all our outside contributors for their efforts!** 👏
 
 !!! note
-We are hoping to have full support for Python 3.11 soon. Please [open an issue](https://github.com/memgraph/gqlalchemy/issues) if you have any blockers with the current update.
+    We are hoping to have full support for Python 3.11 soon. Please [open an issue](https://github.com/memgraph/gqlalchemy/issues) if you have any blockers with the current update.
 
 ## v1.4.1 - April 19, 2023
 

diff --git a/docs/installation.md b/docs/installation.md
@@ -8,7 +8,14 @@ as pip and Poetry, and by building it from source.
 To install GQLAlchemy, you will need the following:
 
 - **Python 3.8 - 3.11**
-- `pymgclient` [build prerequisites](https://memgraph.github.io/pymgclient/introduction.html#build-prerequisites): GQLAlchemy is built on top of Memgraph's low-level Python client `pymgclient`
+- [`pymgclient`](https://github.com/memgraph/pymgclient):
+
+    * Install `pymgclient` [build prerequisites](https://memgraph.github.io/pymgclient/introduction.html#build-prerequisites)
+    * Install `pymgclient` via pip:
+
+    ```bash
+    pip install --user pymgclient
+    ```
 
 !!! danger
     Python 3.11 users: On Windows, GQLAlchemy is not yet compatible with this Python version. Linux users can install GQLAlchemy **without** the DGL extra (due to its dependencies not supporting Python 3.11 yet). If this is currently a blocker for you, please let us know by [opening an issue](https://github.com/memgraph/gqlalchemy/issues).
@@ -34,20 +41,18 @@ pip install gqlalchemy[docker] # Docker support
 pip install gqlalchemy[all] # All of the above
 ```
 
-!!! note
-If you are using the zsh terminal, surround `gqlalchemy[$extras)]` with quotes:
-
-    ```bash
-    pip install 'gqlalchemy[arrow]'
-    ```
-
 If you intend to use GQLAlchemy with PyTorch Geometric support, that library must be installed manually:
 
 ```bash
 pip install gqlalchemy[torch_pyg] # prerequisite
 pip install torch-scatter torch-sparse torch-cluster torch-spline-conv torch-geometric -f https://data.pyg.org/whl/torch-1.13.0+cpu.html"
 ```
 
+!!! note
+    If you are using the zsh terminal, surround `gqlalchemy[$extras]` with quotes:
+    ```bash
+    pip install 'gqlalchemy[arrow]'
+    ```
 ## Build from source
 
 Clone or download the [GQLAlchemy source code](https://github.com/memgraph/gqlalchemy) locally and run the following command to build it from source with Poetry: