Skip to content

Commit

Permalink
Polishes readme
Browse files Browse the repository at this point in the history
  • Loading branch information
louismrose committed Apr 18, 2024
1 parent cfe410f commit 2dc4c09
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ implementation "com.zamzar:zamzar-java:0.0.14"

### Getting Started

Please follow the [installation](#installation) instruction and execute the following Java code:
Please follow the [installation](#installation) instructions and execute the following Java code:

```java
import com.zamzar.api.ZamzarClient;
Expand All @@ -60,10 +60,10 @@ import java.io.File;
public class GettingStarted {
public static void main(String[] args) throws ApiException {
// Signup for a Zamzar API Account or retrieve your existing API Key from https://developers.zamzar.com
ZamzarClient client = new ZamzarClient("YOUR_API_KEY_GOES_HERE");
ZamzarClient zamzar = new ZamzarClient("YOUR_API_KEY_GOES_HERE");

// Converts /tmp/example.docx to /tmp/example.pdf
client
zamzar
.convert(new File("/tmp/example.docx"), "pdf") // uploads and converts your file
.store(new File("/tmp/")) // downloads the converted file
.deleteAllFiles(); // removes your files (example.docx and example.pdf) from Zamzar's servers
Expand All @@ -83,7 +83,7 @@ production credits:
import com.zamzar.api.ZamzarClient;
import com.zamzar.api.ZamzarEnvironment;

ZamzarClient client = new ZamzarClient("YOUR_API_KEY_GOES_HERE", ZamzarEnvironment.SANDBOX);
ZamzarClient zamzar = new ZamzarClient("YOUR_API_KEY_GOES_HERE", ZamzarEnvironment.SANDBOX);
```

The Zamzar Java library uses the production environment by default, but you can also specify it explicitly:
Expand All @@ -92,7 +92,7 @@ The Zamzar Java library uses the production environment by default, but you can
import com.zamzar.api.ZamzarClient;
import com.zamzar.api.ZamzarEnvironment;

ZamzarClient client = new ZamzarClient("YOUR_API_KEY_GOES_HERE", ZamzarEnvironment.PRODUCTION);
ZamzarClient zamzar = new ZamzarClient("YOUR_API_KEY_GOES_HERE", ZamzarEnvironment.PRODUCTION);
```

### Logging
Expand Down Expand Up @@ -123,7 +123,7 @@ OkHttpClient customHttpClient = new OkHttpClient.Builder()
.writeTimeout(10, TimeUnit.SECONDS)
.addInterceptor(/* your own retry interceptor */)
.build();
ZamzarClient client = new ZamzarClient("YOUR_API_KEY_GOES_HERE", customTransport);
ZamzarClient zamzar = new ZamzarClient("YOUR_API_KEY_GOES_HERE", customTransport);
```

## Resources
Expand Down

0 comments on commit 2dc4c09

Please sign in to comment.