From ad3a5e3eb64c46969ddc38ef873bc2020a1ab114 Mon Sep 17 00:00:00 2001
From: Bronley Plumb <bronley@gmail.com>
Date: Mon, 19 Aug 2024 15:48:33 -0400
Subject: [PATCH 1/3] Update readme and prepare for release

---
 .vscode/settings.json |  1 -
 README.md             | 57 ++++++++++++++++++++++++++++++++++++++++---
 package.json          |  4 +--
 3 files changed, 56 insertions(+), 6 deletions(-)

diff --git a/.vscode/settings.json b/.vscode/settings.json
index c80ab65..3d00bdc 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -2,7 +2,6 @@
     "editor.tabSize": 4,
     "editor.insertSpaces": true,
     "editor.detectIndentation": false,
-    "editor.formatOnSave": true,
     "cSpell.words": [
         "brighterscript",
         "findnode",
diff --git a/README.md b/README.md
index 3ea5f55..840698c 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
 # bsc-plugin-auto-findnode
+
 A BrighterScript plugin that auto-injects `m.top.findNode()` calls in your component `init()` functions
 
 [![build status](https://img.shields.io/github/actions/workflow/status/rokucommunity/bsc-plugin-auto-findnode/build.yml?branch=master&logo=github)](https://github.com/rokucommunity/bsc-plugin-auto-findnode/actions?query=branch%3Amaster+workflow%3Abuild)
@@ -20,14 +21,64 @@ npm install bsc-plugin-auto-findnode
 
 ```jsonc
 {
-    "plugins": [
-        "bsc-plugin-auto-findnode"
-    ]
+  "plugins": ["bsc-plugin-auto-findnode"]
 }
 ```
 
 3. Run brighterscript like normal, and the plugin will work!
+
 ```bash
 npx bsc
 ```
 
+## How it works
+
+1. find every xml file in the project
+2. find every element with an ID in that xml file
+3. find the `init()` function for each scope (or create one in a new file)
+4. inject `m.<elementId> = m.top.findNode("<elementId>")` into the init function
+
+For example:
+
+**Before:**
+
+_pkg:/components/ZombieKeyboard.xml_
+
+```xml
+<component name="ZombieKeyboard">
+    <children>
+        <label id="helloZombieText" />
+    </children>
+    <script uri="ZombieKeyboard.brs" />
+</component>
+```
+
+_pkg:/components/ZombieKeyboard.brs_
+
+```brightscript
+sub init()
+    print "init for the keyboard!"
+end sub
+```
+
+**After:**
+
+_pkg:/components/ZombieKeyboard.xml_
+
+```xml
+<component name="ZombieKeyboard">
+    <children>
+        <label id="helloZombieText" />
+    </children>
+    <script uri="ZombieKeyboard.brs" />
+</component>
+```
+
+_pkg:/components/ZombieKeyboard.brs_
+
+```brightscript
+sub init()
+    m.helloZombieText = m.top.findNode("helloZombieText")
+    print "init for the keyboard!"
+end sub
+```
diff --git a/package.json b/package.json
index f791a76..38f3e36 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "bsc-plugin-auto-findnode",
-  "version": "1.0.0",
-  "description": "",
+  "version": "0.0.1",
+  "description": "A BrighterScript plugin that auto-injects `m.top.findNode()` calls in your component `init()` functions",
   "main": "dist/index.js",
   "scripts": {
     "preversion": "npm run build && npm run lint && npm run test",

From 3668d5cf7dd5406e30115cde127f85b3f292b6ae Mon Sep 17 00:00:00 2001
From: Bronley Plumb <bronley@gmail.com>
Date: Mon, 19 Aug 2024 15:48:42 -0400
Subject: [PATCH 2/3] Update changelog for v0.1.0

---
 CHANGELOG.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..77ddfbd
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+
+
+## [0.1.0](https://github.com/rokucommunity/brighterscript/compare/315acc957e1f9e26fa8398d1f6f1926c592355a8...v0.1.0) - 2024-08-19
+- Initial release, which includes:
+ - auto-inject m variables for each element with an ID from xml
+ - warn about all `m.top.findNode` calls in the `init()` function

From 8e1e6a26a4a486d4c2d69ff5cdf8897113eeb32a Mon Sep 17 00:00:00 2001
From: Bronley Plumb <bronley@gmail.com>
Date: Mon, 19 Aug 2024 15:53:01 -0400
Subject: [PATCH 3/3] Prep for release

---
 CHANGELOG.md      | 3 +--
 package-lock.json | 4 ++--
 2 files changed, 3 insertions(+), 4 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 77ddfbd..5080e5c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,8 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
-
-## [0.1.0](https://github.com/rokucommunity/brighterscript/compare/315acc957e1f9e26fa8398d1f6f1926c592355a8...v0.1.0) - 2024-08-19
+## [0.1.0](https://github.com/rokucommunity/bsc-plugin-auto-findnode/compare/315acc957e1f9e26fa8398d1f6f1926c592355a8...v0.1.0) - 2024-08-19
 - Initial release, which includes:
  - auto-inject m variables for each element with an ID from xml
  - warn about all `m.top.findNode` calls in the `init()` function
diff --git a/package-lock.json b/package-lock.json
index 07ea392..a26fb5e 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
   "name": "bsc-plugin-auto-findnode",
-  "version": "1.0.0",
+  "version": "0.0.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "bsc-plugin-auto-findnode",
-      "version": "1.0.0",
+      "version": "0.0.1",
       "license": "ISC",
       "devDependencies": {
         "@types/chai": "^4.3.11",