From 90c2e12ca9d72d4f690fddcc6da870670bf86c43 Mon Sep 17 00:00:00 2001 From: abaskett3 <10681302+abaskett3@users.noreply.github.com> Date: Thu, 1 Oct 2020 22:22:10 -0700 Subject: [PATCH] Fixed Markdown formatting --- README.md | 2 +- creating-dialogs.md | 2 +- dev-guidelines.md | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index cf4edd2..e470f6b 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ And some general guidelines for ReadyAPI plugin development. If you're looking for some specific content - please don't hesitate to [open an issue](https://github.com/SmartBear/ready-api-plugins/issues/new)! -##Existing Plugins +## Existing Plugins Many of the existing plugins are open-sourced here at GitHub and make use of the above outlined extension points and concepts. Have a look at them to get an understanding of how to add similar features to your plugins: diff --git a/creating-dialogs.md b/creating-dialogs.md index e3e9fc3..863a639 100644 --- a/creating-dialogs.md +++ b/creating-dialogs.md @@ -1,4 +1,4 @@ -#Creating Dialogs +# Creating Dialogs Ready! API has a rather elaborate framework for building dialogs that look and behave consistently, relieving you of having to write code specifically for Swing components, layouts, etc. Using the framework is achieved by the diff --git a/dev-guidelines.md b/dev-guidelines.md index 0148973..d24a680 100644 --- a/dev-guidelines.md +++ b/dev-guidelines.md @@ -1,4 +1,4 @@ -#General Guidelines +# General Guidelines General topics to help you build your plugins: @@ -15,7 +15,7 @@ General topics to help you build your plugins: - Building common UI elements (toolbars, splitters, panels) - Opening windows for objects from the Ready! API object model -##Logging +## Logging Due to backwards compatibility requirements with the old SoapUI Pro codebase we still use log4j under the hood, but we use slf4j for the actual logging calls in new Ready! API code - using the log4j bridge for slf4j underneath. For classes created with Guice you can create a looger with: @@ -33,7 +33,7 @@ can be injected). Currently the injector just does the same as `LoggerFactory.getLogger( )` -##Usage Analytics +## Usage Analytics Ready! API provides an analytics API to track a users actions anonymously as they use the application. Adding your own counters is extremely easy, and SmartBear can provide you with data on the values of these counters over time. @@ -55,7 +55,7 @@ The first call above simply logs the that user has used the "DoSomething" action arguments are optional - but always need to be added in pairs (name,value); the second call above adds a "Type" parameter with the value "VeryCool" - use this possibility where you have a limited set of possible values, for example an enumeration. -##The Event Bus +## The Event Bus Ready! API internally uses an event-bus for triggering/handling both synchronous and asynchronous events. This is meant to (over time) replace the listener approach in the SoapUI code-base; instead of each observable object handling its own collection of listeners it can use the event-bus for distributing messages.