Skip to content

update readme #13

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

Merged
OdunlamiZO merged 1 commit into from
Dec 16, 2025
Merged

update readme #13

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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,16 +54,16 @@ A minimal and type-safe Java SDK for interacting with JsonBin.io. This SDK allow
### Setup

```java
JsonBin<UserList> jsonBin =
new JsonBinOkHttp.Builder().withMasterKey("JSONBIN_MASTER_KEY").build(UserList.class);
JsonBin jsonBin =
new JsonBinOkHttp.Builder().withMasterKey("JSONBIN_MASTER_KEY").build();
```

### Example: Calling the API

Here's a basic example of using the SDK to read a bin from JSONBin.io:

```java
Bin<UserList> bin = jsonBin.readBin("687644d36063391d31ae163f");
Bin<UserList> bin = jsonBin.readBin("687644d36063391d31ae163f", UserList.class);
System.out.println(bin);
// Bin(record={users=[{name=Morounfoluwa Mary, age=19}]}, metadata=Metadata(id=687644d36063391d31ae163f, _private=false, createdAt=2025-07-15T12:08:51.887Z, name=Java SDK Test))
```
Expand Down