Skip to content

Fixed Markdown formatting #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fixed Markdown formatting #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion creating-dialogs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 4 additions & 4 deletions dev-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#General Guidelines
# General Guidelines

General topics to help you build your plugins:

Expand All @@ -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:

Expand All @@ -33,7 +33,7 @@ can be injected).

Currently the injector just does the same as `LoggerFactory.getLogger( <requesting class> )`

##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.
Expand All @@ -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.

Expand Down