Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
caseyscarborough committed Aug 30, 2023
1 parent e080354 commit ce387b0
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,17 @@ AnkiConnect ankiconnect = new AnkiConnect("localhost", 8765, "my-api-key");

### Find Cards

This function will allow you to find cards based on a search query. The search query is the same as the one used in the Anki desktop client.
Find cards based on a search query. The search query is the same as the ones used in the Anki desktop client.

```java
List<Long> ids = ankiconnect.findCards("deck:Default");
```

More information about the search query can be found [here](https://docs.ankiweb.net/searching.html).


### Cards Info

This function will allow you to get information about a list of cards.
Retrieve information about a list of cards.

```java
List<Long> ids = ankiconnect.findCards("is:suspended");
Expand All @@ -62,6 +61,8 @@ List<Card> cards = ankiconnect.cardsInfo(ids);

### Reviews for Cards

Retrieve a list of reviews for one or more cards.

```java
// Get reviews for a single cards
List<Review> reviews = ankiconnect.getReviewsOfCard(124248248824L);
Expand Down

0 comments on commit ce387b0

Please sign in to comment.