Skip to content

Commit bec244f

Browse files
authored
Update README to use listItems method instead of listFiles (#30)
1 parent a662cc5 commit bec244f

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ and folders ("collections"). The hash indicates the full current state to manage
2121
## Usage
2222

2323
To explore files in the cloud, you need to first register your api and persist
24-
the token. Then you can use `listFiles` to explore entries of different file
24+
the token. Then you can use `listItems` to explore entries of different file
2525
collections.
2626

2727
```ts
@@ -31,7 +31,7 @@ const code = "..."; // eight letter code from https://my.remarkable.com/device/d
3131
const token = await register(code);
3232
// persist token so you don't have to register again
3333
const api = await remarkable(token);
34-
const fileEntries = await api.listFiles();
34+
const fileEntries = await api.listItems();
3535
```
3636

3737
To upload an epub or pdf, simply call upload with the appropriate name and buffer.
@@ -53,7 +53,7 @@ Using these apis is a little riskier since they can potentially result in data l
5353
// upload with custom line height not avilable through reMarkable
5454
await api.putEpub("name", buffer, { lineHeight: 180 })
5555

56-
// fetch an uploaded pdf, using the hash (from listFiles)
56+
// fetch an uploaded pdf, using the hash (from listItems)
5757
const buffer = await api.getEpub(hash)
5858
```
5959

0 commit comments

Comments
 (0)