Skip to content
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

fix: update readme and contribution guide #45

Merged
merged 1 commit into from
Feb 4, 2025
Merged

fix: update readme and contribution guide #45

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ const client = new VlmRun({
});

// Process an image (using image url)
imageUrl =
const imageUrl =
"https://storage.googleapis.com/vlm-data-public-prod/hub/examples/document.invoice/invoice_1.jpg";
const response = await client.image.generate({
images: [imageUrl],
Expand Down Expand Up @@ -94,7 +94,7 @@ const response = await client.document.generate({
console.log(response);

// Process a document (using url)
documentUrl =
const documentUrl =
"https://storage.googleapis.com/vlm-data-public-prod/hub/examples/document.invoice/google_invoice.pdf";
const response = await client.document.generate({
url: documentUrl,
Expand Down
8 changes: 8 additions & 0 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,16 @@ npm install

3. Run tests:

Add .env.test file with the following variables:

```bash
TEST_API_KEY=<your-api-key>
TEST_BASE_URL=https://dev.vlm.run/v1
```

```bash
npm test
npm run test:integration
```

## Code Style
Expand Down