From 801c6587b9f04ace30726b0f7a5aa781ad2f2300 Mon Sep 17 00:00:00 2001
From: Ricardo Loureiro <ricardo@devsparkle.me>
Date: Sat, 3 Dec 2022 02:27:06 +0000
Subject: [PATCH] Add installation instructions

---
 README.md | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 889f1c5..ad66928 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,32 @@
 # sentry-roblox
-An unofficial Roblox SDK for Sentry.io
+An unofficial Roblox SDK for [Sentry.io](http://sentry.io)
+
+## Getting Started
+There are two supported ways to get Sentry quickly up-and-running in your game:
+
+### Public Module Install
+This install has the benefit of auto-updating whenever we release bugfixes, security patches and even new features; all without having to update your game or pre-existing code.
+
+*Note:* This method cannot be used from a client script. To forward errors from the client, you must use another installation method.
+
+Create a server-sided script in your game, and paste the following contents:
+```lua
+local SentrySDK = require(11721929587)
+
+SentrySDK:Init({
+	DSN = "<DSN FROM YOUR SENTRY PROJECT>"
+})
+```
+
+### Static Install
+Head over to the [releases tab](http://github.com/devSparkle/sentry-roblox/releases) and download the prepared `.rbxm` file. Insert this file into your game and drag it wherever you'd like to keep your ModuleScripts. It must be parented somewhere that replicates to clients, such as `ReplicatedStorage`, if you intend to monitor client errors too.
+
+Then, require your script by calling its path:
+
+```lua
+local SentrySDK = require(game:GetService("ReplicatedStorage").SentrySDK)
+
+SentrySDK:Init({
+	DSN = "<DSN FROM YOUR SENTRY PROJECT>"
+})
+```
\ No newline at end of file