Skip to content
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.

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

Updating readme #37

Merged
merged 1 commit into from
Dec 11, 2024
Merged
Changes from all commits
Commits
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
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,27 @@ public class Example {

```

## Checking Credentials

If you would like to test your credentials using our functionality tests you can do the following.

Navigate to the folder where the package is installed. In the command line run:

```sh
export API_HOST="{host}"
export API_KEY="{key}"
```

Replacing {host} and {key} with the credentials you were given. Make sure to include the quotation marks.

Then while inside the package folder, run:

```sh
mvn test
```

You should be able to see the tests run.

## Documentation for API Endpoints

All URIs are relative to *https://api.lilt.com*
Expand Down