From 0e88d4c71febd084680f3d10c823dfbd622989e0 Mon Sep 17 00:00:00 2001
From: Steve Ayers <sayers@buf.build>
Date: Fri, 11 Aug 2023 10:11:58 -0400
Subject: [PATCH] Update

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

diff --git a/README.md b/README.md
index f778b08..c3d4edf 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,30 @@
 An extension of [jest-environment-jsdom](https://www.npmjs.com/package/jest-environment-jsdom)
 with support for the [Encoding API](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API).
 
+## Installation
+
+Note that `jest-environment-jsdom` is still required as a peer dependency:
+
+```bash
+npm install --save-dev jest-environment-jsdom @bufbuild/jest-environment-jsdom
+```
+
+## Usage
+
+Update the `testEnvironment` property of your Jest config like so:
+
+```diff
+import type { Config } from 'jest';
+
+const config: Config = {
+- testEnvironment: 'jsdom',
++ testEnvironment: '@bufbuild/jest-environment-jsdom',
+...
+};
+```
+
+Full documentation can be found in the package [README](packages/jest-environment-jsdom).
+
 ## Packages
 
 - [@bufbuild/jest-environment-jsdom](https://www.npmjs.com/package/@bufbuild/jest-environment-jsdom)