Skip to content

docs(readme): correct branding, docs link, sandbox host, and usage typos #3

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.

Sign up for GitHub

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

Open
RitwijParmar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(readme): correct branding, docs link, sandbox host, and usage typos #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 6 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
[![Maven Central](https://img.shields.io/maven-central/v/com.flagright.api/flagright-java)](https://central.sonatype.com/artifact/com.flagright.api/flagright-java)
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)

The Merge Java SDK provides convenient access to the Merge API from Java or Kotlin.
The Flagright Java SDK provides convenient access to the Flagright API from Java or Kotlin.

## Documentation

API documentation is available at [here](https://central.sonatype.com/artifact/com.flagright.api/flagright-java).
API documentation is available at <https://docs.flagright.com>.

## Installation

Expand All @@ -30,7 +30,7 @@ Add the dependency in your `pom.xml`:
<groupId>com.flagright.api</groupId>
<artifactId>flagright-java</artifactId>
<version>x.x.x</version>
</dependency
</dependency>
```

## Usage
Expand All @@ -43,16 +43,17 @@ import com.flagright.api.types.TransactionsVerifyResponse;
import com.flagright.api.resources.transactions.requests.TransactionsVerifyRequest;

FlagrightApiClient flagright = FlagrightApiClient.builder()
.environment("https://sandbox.flagright.com")
.environment("https://sandbox.api.flagright.com")
.apiKey("YOUR_API_KEY")
.build();

TransactionsVerifyResponse resposne = flagright.transactions.verify(TransactionsVerifyRequest.builder()
TransactionsVerifyResponse response = flagright.transactions.verify(TransactionsVerifyRequest.builder()
.body(Transaction.builder()
.transactionId("my-transaction-id")
.type(TransactionType.DEPOSIT)
.timestamp(1692624734000.0)
.build()
)
.build());
```

Expand Down