From 51737844c4c7f80fe7687a5927fa95d2aa444d5d Mon Sep 17 00:00:00 2001
From: Jonathan Cornaz <jcornaz@users.noreply.github.com>
Date: Wed, 18 May 2022 21:55:59 +0200
Subject: [PATCH] docs(readme): add installation and MSRV

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index a374a56..fb401a0 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,23 @@ bvh.for_each_overlaping_pair(|a, b| println!("{a} overlaps {b}"));
 This crate is `no_std` compatible but requires a [global allocator](https://doc.rust-lang.org/stable/core/alloc/trait.GlobalAlloc.html).
 
 
+## Installation
+
+Add to `Cargo.toml`:
+
+```toml
+bvh-arena = "1"
+```
+
+## MSRV
+
+The minimum supported rust version is currently: `1.58`
+
+**It *may* be increased to a newer stable version in a minor release.** (but only if needed)
+
+It *will* be increased to the latest stable version in a major release. (even if not needed)
+
+
 ## Motivation
 
 In the context of building my own collision detection logic, I wanted to use a bounding-volume-hierarchy (BVH)