From e53dbe3d3192eeaf71897756edb182b991bdbfbe Mon Sep 17 00:00:00 2001
From: BoykoAlex <aboyko@pivotal.io>
Date: Thu, 23 Nov 2017 15:54:03 -0500
Subject: [PATCH] PT #153123095 Add readme for boot-properties

---
 .../atom-boot-properties/README.MD            | 51 +++++++++++++++++++
 .../atom-boot-properties/lib/main.js          |  1 -
 2 files changed, 51 insertions(+), 1 deletion(-)
 create mode 100644 atom-extensions/atom-boot-properties/README.MD

diff --git a/atom-extensions/atom-boot-properties/README.MD b/atom-extensions/atom-boot-properties/README.MD
new file mode 100644
index 000000000..8cd5ab96c
--- /dev/null
+++ b/atom-extensions/atom-boot-properties/README.MD
@@ -0,0 +1,51 @@
+# Atom package for Spring Boot Application Properties
+
+Atom package and Language Server providing support for editing `application.properties` 
+and `application.yml` files containing Spring Boot configuration properties.
+
+## Installation:
+
+Install it from Atom `Install Packages`, search for `boot-properties` 
+
+## Usage:
+
+The extension will automatically activate when you edit files with the following
+name patterns:
+
+ - `application.properties` => activates support for .properties file format.
+ - `application.yml` => activates support for .yml file format.
+ 
+For all other files select grammar to be `Spring-Boot-Properties` for `properties` file format or `Spring-Boot-Properties-YAML` for 'YAML' file format
+
+# Developer notes
+
+## Bulding and Running
+
+To build all these pieces you normally only need to run:
+
+    npm install
+
+Now you can link it to Atom:
+
+    apm link .
+
+Open Atom or execute `Refresh Window` in the opened instance (Packages -> Command Palette -> Toggle then search for the command).
+
+## Debugging
+
+**Client Side Debugging**: Open Atom's `Developer Tools` view - View -> Developer -> Toggle Developer Tools
+
+**Server Side Debugging**:  Change `launchVmArgs(version)` implementation in `lib/main.js` to be:
+```
+    launchVmArgs(version) {
+        return Promise.resolve([
+            '-Xdebug',
+            '-agentlib:jdwp=transport=dt_socket,server=y,address=7999,suspend=n',
+            '-Dorg.slf4j.simpleLogger.logFile=boot-properties.log',
+            '-Dorg.slf4j.simpleLogger.defaultLogLevel=debug',
+        ]);
+    }
+
+```
+(Then setup the remote debugger from your IDE on the same port `7999`)
+
diff --git a/atom-extensions/atom-boot-properties/lib/main.js b/atom-extensions/atom-boot-properties/lib/main.js
index 40599de16..bb7fef693 100644
--- a/atom-extensions/atom-boot-properties/lib/main.js
+++ b/atom-extensions/atom-boot-properties/lib/main.js
@@ -38,7 +38,6 @@ class BootPropertiesClient extends JavaProcessLanguageClient {
             '-Dorg.slf4j.simpleLogger.logFile=boot-properties.log',
             '-Dorg.slf4j.simpleLogger.defaultLogLevel=debug',
         ]);
-
     }
 
 }