Skip to content

Commit

Permalink
improve readme for standalone jar awareness
Browse files Browse the repository at this point in the history
ptrthomas committed Jul 20, 2018
1 parent 05b3f47 commit e18bd63
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -6,7 +6,7 @@ Karate enables you to script a sequence of calls to any kind of web-service and

Karate is the only open-source tool that combines web-API testing and [test-doubles](karate-netty) into a single, *unified* test automation framework. And you can re-use API Functional Tests as [Performance Tests](karate-gatling) !

Since Karate is built on top of [Cucumber-JVM](https://github.com/cucumber/cucumber-jvm), you can run tests and generate reports like any standard Java project. But instead of Java - you write tests in a language designed to make dealing with HTTP, JSON or XML - **simple**.
Since Karate is built on top of [Cucumber-JVM](https://github.com/cucumber/cucumber-jvm), you can run tests and generate reports like any standard Java project. But there is also a [stand-alone executable](karate-netty#standalone-jar) for teams that are not comfortable with Java. And you can write tests in a language-neutral syntax designed to make dealing with HTTP, JSON or XML - **simple**.

## Hello World

@@ -55,7 +55,7 @@ And you don't need to create additional Java classes for any of the payloads tha
</td>
</tr>
<tr>
<th>Data</th>
<th>Types</th>
<td>
<a href="#json">JSON</a>
| <a href="#xml">XML</a>
@@ -84,7 +84,7 @@ And you don't need to create additional Java classes for any of the payloads tha
</td>
</tr>
<tr>
<th>Operations</th>
<th>Actions</th>
<td>
<a href="#assert"><code>assert</code></a>
| <a href="#print"><code>print</code></a>
@@ -101,7 +101,7 @@ And you don't need to create additional Java classes for any of the payloads tha
</td>
</tr>
<tr>
<th>HTTP Core</th>
<th>HTTP</th>
<td>
<a href="#url"><code>url</code></a>
| <a href="#path"><code>path</code></a>
@@ -112,7 +112,7 @@ And you don't need to create additional Java classes for any of the payloads tha
</td>
</tr>
<tr>
<th>HTTP Data</th>
<th>Request</th>
<td>
<a href="#param"><code>param</code></a>
| <a href="#header"><code>header</code></a>
@@ -141,7 +141,7 @@ And you don't need to create additional Java classes for any of the payloads tha
</td>
</tr>
<tr>
<th>Assertions</th>
<th>Assert</th>
<td>
<a href="#match"><code>match ==</code></a>
| <a href="#match--not-equals"><code>match !=</code></a>
@@ -304,6 +304,8 @@ mvn archetype:generate \

This will create a folder called `myproject` (or whatever you set the name to).

> You can also try using Karate as a [stand-alone executable](karate-netty#standalone-jar) which is a good option if you have difficulties with the above process, or if you are not comfortable with Maven or Java.
### Eclipse Quickstart

You can refer to this [nice blog post and video](https://www.joecolantonio.com/2017/03/23/rest-test-tool-karate-api-testing/) by Joe Colantonio which provides step by step instructions on how to get started using Eclipse (without having to run the command above). Use the latest available version of Karate (refer to the `archetypeVersion` above), and also make sure you install the [Cucumber-Eclipse plugin](https://cucumber.io/cucumber-eclipse/) !

0 comments on commit e18bd63

Please sign in to comment.