Skip to content

Update README to use listItems method instead of listFiles #30

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README to use listItems method instead of listFiles #30

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 @@ -21,7 +21,7 @@ and folders ("collections"). The hash indicates the full current state to manage
## Usage

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

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

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

// fetch an uploaded pdf, using the hash (from listFiles)
// fetch an uploaded pdf, using the hash (from listItems)
const buffer = await api.getEpub(hash)
```

Expand Down