Skip to content
This repository was archived by the owner on Jun 11, 2024. It is now read-only.

Commit e21372c

Browse files
dpowelldpowell
committed
A few more minor documentation cleanups
1 parent d8606fc commit e21372c

File tree

15 files changed

+239
-141
lines changed

15 files changed

+239
-141
lines changed

‎.idea/compiler.xml‎

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎.idea/encodings.xml‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

‎.idea/misc.xml‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎.idea/vcs.xml‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎.project‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>browserup-proxy</name>
4+
<comment>Project browserup-proxy created by Buildship.</comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
<buildCommand>
9+
<name>org.eclipse.buildship.core.gradleprojectbuilder</name>
10+
<arguments>
11+
</arguments>
12+
</buildCommand>
13+
</buildSpec>
14+
<natures>
15+
<nature>org.eclipse.buildship.core.gradleprojectnature</nature>
16+
</natures>
17+
</projectDescription>

‎README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
BrowserUp Proxy allows you to manipulate HTTP requests and responses, capture HTTP content, and export performance data as a [HAR file](http://www.softwareishard.com/blog/har-12-spec/).
44
BrowserUp Proxy works well as a standalone proxy server, but it is especially useful when embedded in Selenium tests.
55

6-
BrowserUp Proxy is originally forked from [BrowserMobProxy](https://github.com/lightbody/browsermob-proxy) and is powered by [LittleProxy](https://github.com/adamfisk/LittleProxy).
6+
BrowserUp Proxy is originally forked from [BrowserMobProxy](https://github.com/lightbody/browsermob-proxy) and is powered by [LittleProxy](https://github.com/mrog/LittleProxy).
77
See [CHANGELOG.md] for updates.
88

99
If you're running BrowserUp Proxy within a Java application or Selenium test, get started with [Embedded Mode](#getting-started-embedded-mode). If you want to run BUP from the
@@ -13,17 +13,17 @@ command line as a standalone proxy, start with [Standalone](#getting-started-sta
1313
To use BrowserUp Proxy in your tests or application, add the `browserup-proxy-core` dependency to your pom:
1414
```xml
1515
<dependency>
16-
<groupId>com.browserup.bup</groupId>
16+
<groupId>com.browserup</groupId>
1717
<artifactId>browserup-proxy-core</artifactId>
18-
<version>1.0.0-SNAPSHOT</version>
18+
<version>1.0.0</version>
1919
<scope>test</scope>
2020
</dependency>
2121
```
2222

2323
Start the proxy:
2424
```java
2525
BrowserUpProxy proxy = new BrowserUpProxyServer();
26-
proxy.start(0);
26+
proxy.start();
2727
int port = proxy.getPort(); // get the JVM-assigned port
2828
// Selenium or HTTP client configuration goes here
2929
```
@@ -63,9 +63,9 @@ The proxy is programmatically controlled via a REST interface or by being embedd
6363

6464
### REST API
6565

66-
To get started, first start the proxy by running `BrowserUp-proxy` or `BrowserUp-proxy.bat` in the bin directory:
66+
To get started, first start the proxy by running `browserup-proxy` or `browserup-proxy.bat` in the bin directory:
6767

68-
$ sh BrowserUp-proxy -port 8080
68+
$ sh browserup-proxy -port 8080
6969
INFO 05/31 03:12:48 o.b.p.Main - Starting up...
7070
2011-05-30 20:12:49.517:INFO::jetty-7.3.0.v20110203
7171
2011-05-30 20:12:49.689:INFO::started o.e.j.s.ServletContextHandler{/,null}
@@ -153,12 +153,12 @@ system properties will be used to specify the upstream proxy.
153153

154154
### Embedded Mode
155155

156-
BrowserUp Proxy separates the Embedded Mode and REST API into two modules. If you only need Embedded Mode functionality, add the `BrowserUp-core` artifact as a dependency. The REST API artifact is `BrowserUp-rest`.
156+
BrowserUp Proxy separates the Embedded Mode and REST API into two modules. If you only need Embedded Mode functionality, add the `browserup-core` artifact as a dependency. The REST API artifact is `browserup-rest`.
157157

158158
If you're using Java and Selenium, the easiest way to get started is to embed the project directly in your test. First, you'll need to make sure that all the dependencies are imported in to the project. You can find them in the *lib* directory. Or, if you're using Maven, you can add this to your pom:
159159
```xml
160160
<dependency>
161-
<groupId>com.browserup.bup</groupId>
161+
<groupId>com.browserup</groupId>
162162
<artifactId>browserup-proxy-core</artifactId>
163163
<version>1.0.0/version>
164164
<scope>test</scope>
@@ -168,7 +168,7 @@ If you're using Java and Selenium, the easiest way to get started is to embed th
168168
Once done, you can start a proxy using `com.browserup.bup.BrowserUpProxy`:
169169
```java
170170
BrowserUpProxy proxy = new BrowserUpProxyServer();
171-
proxy.start(0);
171+
proxy.start();
172172
// get the JVM-assigned port and get to work!
173173
int port = proxy.getPort();
174174
//...
@@ -184,7 +184,7 @@ BrowserUp Proxy makes it easy to use a proxy in Selenium tests:
184184
```java
185185
// start the proxy
186186
BrowserUpProxy proxy = new BrowserUpProxyServer();
187-
proxy.start(0);
187+
proxy.start();
188188

189189
// get the Selenium proxy object
190190
Proxy seleniumProxy = ClientUtil.createSeleniumProxy(proxy);

‎browserup-proxy-core/.classpath‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<classpath>
3+
<classpathentry kind="src" output="bin/main" path="src/main/java">
4+
<attributes>
5+
<attribute name="gradle_scope" value="main"/>
6+
<attribute name="gradle_used_by_scope" value="main,test"/>
7+
</attributes>
8+
</classpathentry>
9+
<classpathentry kind="src" output="bin/main" path="src/main/resources">
10+
<attributes>
11+
<attribute name="gradle_scope" value="main"/>
12+
<attribute name="gradle_used_by_scope" value="main,test"/>
13+
</attributes>
14+
</classpathentry>
15+
<classpathentry kind="src" output="bin/test" path="src/test/java">
16+
<attributes>
17+
<attribute name="gradle_scope" value="test"/>
18+
<attribute name="gradle_used_by_scope" value="test"/>
19+
</attributes>
20+
</classpathentry>
21+
<classpathentry kind="src" output="bin/test" path="src/test/groovy">
22+
<attributes>
23+
<attribute name="gradle_scope" value="test"/>
24+
<attribute name="gradle_used_by_scope" value="test"/>
25+
</attributes>
26+
</classpathentry>
27+
<classpathentry kind="src" output="bin/test" path="src/test/resources">
28+
<attributes>
29+
<attribute name="gradle_scope" value="test"/>
30+
<attribute name="gradle_used_by_scope" value="test"/>
31+
</attributes>
32+
</classpathentry>
33+
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-11/"/>
34+
<classpathentry kind="con" path="org.eclipse.buildship.core.gradleclasspathcontainer"/>
35+
<classpathentry kind="output" path="bin/default"/>
36+
</classpath>

‎browserup-proxy-core/.project‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>browserup-proxy-core</name>
4+
<comment>Project browserup-proxy-core created by Buildship.</comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
<buildCommand>
9+
<name>org.eclipse.jdt.core.javabuilder</name>
10+
<arguments>
11+
</arguments>
12+
</buildCommand>
13+
<buildCommand>
14+
<name>org.eclipse.buildship.core.gradleprojectbuilder</name>
15+
<arguments>
16+
</arguments>
17+
</buildCommand>
18+
</buildSpec>
19+
<natures>
20+
<nature>org.eclipse.jdt.core.javanature</nature>
21+
<nature>org.eclipse.buildship.core.gradleprojectnature</nature>
22+
</natures>
23+
</projectDescription>

‎browserup-proxy-dist/.classpath‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<classpath>
3+
<classpathentry kind="src" output="bin/main" path="src/main/java">
4+
<attributes>
5+
<attribute name="gradle_scope" value="main"/>
6+
<attribute name="gradle_used_by_scope" value="main,test"/>
7+
</attributes>
8+
</classpathentry>
9+
<classpathentry kind="src" output="bin/main" path="src/main/resources">
10+
<attributes>
11+
<attribute name="gradle_scope" value="main"/>
12+
<attribute name="gradle_used_by_scope" value="main,test"/>
13+
</attributes>
14+
</classpathentry>
15+
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-11/"/>
16+
<classpathentry kind="con" path="org.eclipse.buildship.core.gradleclasspathcontainer"/>
17+
<classpathentry kind="output" path="bin/default"/>
18+
</classpath>

‎browserup-proxy-dist/.project‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>browserup-proxy-dist</name>
4+
<comment>Project browserup-proxy-dist created by Buildship.</comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
<buildCommand>
9+
<name>org.eclipse.jdt.core.javabuilder</name>
10+
<arguments>
11+
</arguments>
12+
</buildCommand>
13+
<buildCommand>
14+
<name>org.eclipse.buildship.core.gradleprojectbuilder</name>
15+
<arguments>
16+
</arguments>
17+
</buildCommand>
18+
</buildSpec>
19+
<natures>
20+
<nature>org.eclipse.jdt.core.javanature</nature>
21+
<nature>org.eclipse.buildship.core.gradleprojectnature</nature>
22+
</natures>
23+
</projectDescription>

0 commit comments

Comments
 (0)