From 8042709cae5c36bcd9480d5fe88bf74bf70bdb41 Mon Sep 17 00:00:00 2001
From: sam <sam@functionless.org>
Date: Fri, 27 May 2022 16:05:59 -0700
Subject: [PATCH 1/2] chore: add README with instructions for installing

---
 README.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b3fa7dd..3ac8025 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,28 @@
-# replace this
\ No newline at end of file
+# Functionless Language Service Plugin
+
+[![npm version](https://badge.fury.io/js/@functionless%2Flanguage-service.svg)](https://badge.fury.io/js/@functionless%2Flanguage-service)
+
+The `@functionless/language-service` package configures a plugin for the TypeScript language service plugin that adds real-time errors to the IDE for [Functionless](https://github.com/functionless/functionless)'s semantic errors.
+
+To configure, first install the module as a devDependency.
+
+```shell
+# if using NPM
+npm install --save-dev @functionless/language-service
+
+yarn add -D @functionless/language-service
+```
+
+Then add as a plugin to your `tsconfig.json`.
+
+```json
+{
+  "compilerOptions": {
+    "plugins": [
+      {
+        "name": "@functionless/language-service"
+      }
+    ]
+  }
+}
+```

From b68a8e8e78375c64ff89056a050584f2c1f311e4 Mon Sep 17 00:00:00 2001
From: sam <sam@functionless.org>
Date: Fri, 27 May 2022 16:06:50 -0700
Subject: [PATCH 2/2] fix: minor fix to readme

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

diff --git a/README.md b/README.md
index 3ac8025..a22c739 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,7 @@ To configure, first install the module as a devDependency.
 # if using NPM
 npm install --save-dev @functionless/language-service
 
+# if using yarn
 yarn add -D @functionless/language-service
 ```