Skip to content

Commit e16d19d

Browse files
committed
Re-organizing the Readme
1 parent 7b2ab6d commit e16d19d

File tree

1 file changed

+30
-18
lines changed

1 file changed

+30
-18
lines changed

README.md

Lines changed: 30 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,32 @@
1-
New Relic Synthetics Formatter for Se-Builder
1+
New Relic Synthetics
2+
Formatter for Se-Builder
23
==============================
34

45
Formatter for se-builder - generates javascript to use in New Relic Synthetics Scripted Browser tests.
56

6-
## Download the Plugin
7+
## Download the plugin
78

89
[Download link for plugin](https://github.com/sschwartzman/newrelic-synthetics-sebuilder/blob/master/nr_synthetics_formatter.zip)
910

10-
## Install the Plugin
11+
## Install the pre-requisites
1112

1213
1. Download & install [se-builder](http://www.saucelabs.com/addons/selenium-builder-latest.xpi).
1314
* Yes, you'll need [FireFox](https://www.mozilla.org/en-US/firefox/new/) too.
1415
2. Run Se-builder at least once before proceeding. Running it the first time creates the folder where you'll put the plugin.
15-
* Se-builder will appear as a small icon that looks like a Lego piece in the Firefox add-ons toolbar. Click on that icon to load.
16-
3. [Download the plugin](https://github.com/sschwartzman/newrelic-synthetics-sebuilder/blob/master/nr_synthetics_formatter.zip)
17-
4. Unzip the plugin into the `SeBuilder/plugins` directory on in your Firefox profile.
16+
3. Se-builder will appear as a small icon that looks like a Lego piece in the Firefox add-ons toolbar. Click on that icon to load.
17+
18+
## Install the plugin
19+
20+
1. [Download the plugin](https://github.com/sschwartzman/newrelic-synthetics-sebuilder/blob/master/nr_synthetics_formatter.zip)
21+
2. Unzip the plugin into the `SeBuilder/plugins` directory on in your Firefox profile.
1822
* **NOTE:** The zip contains a folder called `nr_synthetics_formatter`. Move the **FOLDER with enclosed files** into the plugins directory, rather than moving the files themselves without the folder.
19-
* Here are some common locations for the plugins directory across different OSes:
20-
* Mac: `/Users/[you]/Library/Application Support/Firefox/Profiles/[your_profile]/SeBuilder/plugins`
21-
Can't find the "Library" folder? If you need to open it:
22-
1. Open your Home folder in Finder.
23-
2. Right-click in the finder window and click "Show View Options", or open it by pressing ⌘-J.
24-
3. Check the box next to Show Library Folder.
25-
* Win: `C:/Users/[you]/Appdata/Roaming/Mozilla/Firefox/Profiles/[your_profile]/SeBuilder/plugins`
26-
* Linux/Unix: `~/.mozilla/firefox/[your_profile]/SeBuilder/plugins`
27-
5. Restart the se-builder if you still have it running. You don't have to restart Firefox, just exit and re-open Se-builder.
28-
6. To verify that the plugin is loaded, click "Manage plugins" in the opening dialog box. You should see "New Relic Synthetics Formatter #.# Installed" in the Plugins list.
23+
* Can't find the destination folder? Check [Here](#cant-find-the-plugins-directory)
24+
3. Restart the se-builder if you still have it running. You don't have to restart Firefox, just exit and re-open Se-builder.
25+
4. To verify that the plugin is loaded, click "Manage plugins" in the opening dialog box. You should see "New Relic Synthetics Formatter #.# Installed" in the Plugins list.
2926
* *If the Manage Plugins page throws an error, don't fret!* This may be a issue with se-builder that doesn't impact the plugin. If it does happen, try recording a simple script and exporting it. If you see "New Relic Synthetics (WebDriverJS)" in the File -> Export dialog, the plugin is working properly.
3027
* If it didn't load, try restarting Firefox entirely and then re-running Se-builder.
3128

32-
## Using the Formatter
29+
## Using the formatter
3330

3431
1. Write, record or open a test.
3532
* Be sure to create in "Selenium 2" format, or convert your existing script to it.
@@ -45,11 +42,26 @@ Formatter for se-builder - generates javascript to use in New Relic Synthetics S
4542
* In the "Script your steps" window, clear the contents there and paste the contents of your exported script.
4643
* Be sure to click "Validate" below this window pane to ensure that the script works properly.
4744

48-
## Having Issues?
45+
## Having issues?
4946

5047
* Please submit an issue to this github repo by clicking the "Issues" link on the right-hand menu and then click "New Issue"
5148
* Please cut-and-paste the following detail into the issue:
5249
* Your original script created in se-builder - either in HTML or JSON format
5350
* The exported javascript file you pasted into Synthetics
5451
* The error messages and logs returned when you ran/validated your script
5552
* *Please be patient!* Unfortunately, maintaining this script is not my day job, but I will get to your issue as soon as I can.
53+
54+
## Can't find the plugins directory?
55+
56+
Here are some common locations for the plugins directory across different OSes:
57+
58+
* Mac: `/Users/[you]/Library/Application Support/Firefox/Profiles/[your_profile]/SeBuilder/plugins`
59+
* Win: `C:/Users/[you]/Appdata/Roaming/Mozilla/Firefox/Profiles/[your_profile]/SeBuilder/plugins`
60+
* Linux/Unix: `~/.mozilla/firefox/[your_profile]/SeBuilder/plugins`
61+
62+
Can't find the "Library" folder on your Mac? If you need to open it:
63+
64+
1. Open your Home folder in Finder.
65+
2. Right-click in the finder window and click "Show View Options", or open it by pressing ⌘-J.
66+
3. Check the box next to Show Library Folder.
67+

0 commit comments

Comments
 (0)