From beee291cf5be48adf495b345bde80b2232b6d6a7 Mon Sep 17 00:00:00 2001
From: Olaf Haag <83961384+Olaf-Wolf3D@users.noreply.github.com>
Date: Tue, 14 May 2024 16:47:42 +0300
Subject: [PATCH] docs: Update installation instructions in README.md (#19)

provide direct pip install command for a specific version of `readyplayerme-meshops` from GitHub.
---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6f89e46..83d677f 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,27 @@
 
 A collection of tools for dealing with mesh related data.
 
-## Setup
+## Installation
+
+To install a specific version  of `readyplayerme-meshops` directly from github:
+
+```bash
+pip install "ReadyPlayerMe-MeshOps@https://github.com/readyplayerme/meshops/releases/download/0.1.0/readyplayerme_meshops-0.1.0-py3-none-any.whl"
+```
+
+You need to change the tag (0.1.0 in this example) to the version you want to install.
+
+Alternatively, you can also download the latest wheel file from the [Releases](https://github.com/readyplayerme/meshops/releases/latest) and install it using pip:
+
+1. Navigate to the [Releases](https://github.com/<username>/meshops/releases) page of the `meshops` GitHub repository.
+2. Download the latest `.whl` file.
+3. Install the wheel file using pip, e.g.:
+
+```bash
+pip install <path-to-download>/readyplayerme_meshops-0.1.0-py3-none-any.whl
+```
+
+## Development Setup
 
 You'll find setup instruction of this project in the [CONTRIBUTING.md](https://github.com/readyplayerme/meshops/blob/main/CONTRIBUTING.md) file.