From 079c359844e010308f3878002caa56fa22d5a6ca Mon Sep 17 00:00:00 2001
From: SbDove <100377552+SbDove@users.noreply.github.com>
Date: Tue, 16 Jul 2024 10:42:34 -0700
Subject: [PATCH] docs: Update readme to include usage instructions (#14)

---
 README.md | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index f9c4c1a..9df4308 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,23 @@
 Heap Integration
 ===========================
 
-Heap SDK integration for mParticle.
+This repo contains client-side, Javascript integration to Heap.
+
+# Usage
+
+JS kits are automatically included with your mParticle.js file when loading mParticle via the [snippet](https://docs.mparticle.com/developers/sdk/web/getting-started/#add-the-sdk-snippet).
+
+If loading mParticle via [npm](https://docs.mparticle.com/developers/sdk/web/self-hosting/), you will have to manually include either the client side Heap kit via npm.
+
+```
+npm i @mparticle/web-heap-kit
+```
+
+Full documentation on usage can be found [here](https://docs.mparticle.com/integrations/heap/event/).
 
 # License
 
-Copyright 2019 mParticle, Inc.
+Copyright 2024 mParticle, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.