From 49927410589450d39a1dec8c92e1401bbe94397a Mon Sep 17 00:00:00 2001
From: Jason Kuhrt <jasonkuhrt@me.com>
Date: Thu, 18 Feb 2021 22:56:13 -0500
Subject: [PATCH] docs: peer deps validation

references #2
---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index e4cc3d6cf..5e5924d10 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,16 @@
 [![trunk](https://github.com/prisma/nexus-prisma/actions/workflows/trunk.yml/badge.svg)](https://github.com/prisma/nexus-prisma/actions/workflows/trunk.yml)
 
 Official Prisma plugin for Nexus
+
+## Features
+
+### Opt-outable friendly runtime peer dependency checks
+
+When `nexus-prisma` is imported it will validate that your project has peer dependencies setup correctly.
+
+If a peer dependenvy is not installed it `nexus-prisma` will log an error and then exit 1. If its version does not satify the range supported by the current version of `nexus-prisma` that you have installed, then a warning will be logged. If you want to opt-out of this validation then set an envar as follows:
+
+```
+NO_PEER_DEPENDENCY_CHECK=true|1
+PEER_DEPENDENCY_CHECK=false|0
+```