Skip to content

Commit cc80cfe

Browse files
Simplify VB.NET dispatcher commands and update usage examples
- Removed `--project VBNetSamples.vbproj` argument for all `dotnet` commands across documentation and sample scripts. - Updated all usage examples in `README.md`, `AGENTS.md`, and VB.NET examples for consistency. - Refined build and run instructions to align with cleaner syntax. - Improved tip section formatting for piping output to files.
1 parent 4149964 commit cc80cfe

8 files changed

Lines changed: 28 additions & 28 deletions

File tree

VB.NET/AGENTS.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@
1111

1212
## Build, Test, and Development Commands
1313
- Install .NET SDK (8.0+): verify with `dotnet --version`.
14-
- Restore/build: `dotnet restore VBNetSamples.vbproj && dotnet build VBNetSamples.vbproj`.
15-
- Run a sample via dispatcher: `dotnet run --project VBNetSamples.vbproj -- <command> [args]`.
16-
- Example: `dotnet run --project VBNetSamples.vbproj -- markdown /path/to/input.pdf`.
14+
- Restore/build (from VB.NET folder): `dotnet restore && dotnet build`.
15+
- Run a sample via dispatcher: `dotnet run -- <command> [args]`.
16+
- Example: `dotnet run -- markdown /path/to/input.pdf`.
1717
- Dependencies:
1818
- `.env` loading is included via `DotNetEnv`.
19-
- Optional JSON helper: `dotnet add VBNetSamples.vbproj package Newtonsoft.Json` (only if a sample uses it).
19+
- Optional JSON helper: `dotnet add package Newtonsoft.Json` (only if a sample uses it).
2020
- File-focused testing: keep each sample self-contained (accept input path as first arg; minimal edits).
2121

2222
## Coding Style & Naming Conventions
@@ -80,11 +80,11 @@ Template:
8080
' For more information visit https://pdfrest.com/pricing#how-do-eu-gdpr-api-calls-work
8181
'
8282
' Usage (via dispatcher):
83-
' dotnet run --project VBNetSamples.vbproj -- <command-name> /path/to/input.pdf
83+
' dotnet run -- <command-name> /path/to/input.pdf
8484
'
8585
' Output:
8686
' - Prints the API JSON response to stdout. Non-2xx responses write a concise message to stderr and exit non-zero.
87-
' - Tip: pipe output to a file: dotnet run --project VBNetSamples.vbproj -- <command-name> ... > response.json
87+
' - Tip: pipe output to a file: dotnet run -- <command-name> ... > response.json
8888
'''
8989

9090
Notes:

VB.NET/Complex Flow Examples/merge-different-file-types.vb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
' For more information visit https://pdfrest.com/pricing#how-do-eu-gdpr-api-calls-work
1212
'
1313
' Usage (via dispatcher):
14-
' dotnet run --project VBNetSamples.vbproj -- merge-different-file-types /path/to/file1 /path/to/file2 [...]
14+
' dotnet run -- merge-different-file-types /path/to/file1 /path/to/file2 [...]
1515
'
1616
' Output:
1717
' - Prints the API JSON response to stdout. Non-2xx responses write a concise message to stderr and exit non-zero.
18-
' - Tip: pipe output to a file: dotnet run --project VBNetSamples.vbproj -- merge-different-file-types ... > response.json
18+
' - Tip: pipe output to a file: dotnet run -- merge-different-file-types ... > response.json
1919
'''
2020

2121
Option Strict On

VB.NET/Endpoint Examples/JSON Payload/markdown.vb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
' For more information visit https://pdfrest.com/pricing#how-do-eu-gdpr-api-calls-work
1212
'
1313
' Usage (via dispatcher):
14-
' dotnet run --project VBNetSamples.vbproj -- markdown /path/to/input.pdf
14+
' dotnet run -- markdown /path/to/input.pdf
1515
'
1616
' Output:
1717
' - Prints the API JSON response to stdout. Non-2xx responses write a concise message to stderr and exit non-zero.
18-
' - Tip: pipe output to a file: dotnet run --project VBNetSamples.vbproj -- markdown /path/to/input.pdf > response.json
18+
' - Tip: pipe output to a file: dotnet run -- markdown /path/to/input.pdf > response.json
1919
'''
2020

2121
Option Strict On

VB.NET/Endpoint Examples/JSON Payload/rasterized-pdf.vb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
' For more information visit https://pdfrest.com/pricing#how-do-eu-gdpr-api-calls-work
1212
'
1313
' Usage (via dispatcher):
14-
' dotnet run --project VBNetSamples.vbproj -- rasterized-pdf /path/to/input.pdf
14+
' dotnet run -- rasterized-pdf /path/to/input.pdf
1515
'
1616
' Output:
1717
' - Prints the API JSON response to stdout. Non-2xx responses write a concise message to stderr and exit non-zero.
18-
' - Tip: pipe output to a file: dotnet run --project VBNetSamples.vbproj -- rasterized-pdf /path/to/input.pdf > response.json
18+
' - Tip: pipe output to a file: dotnet run -- rasterized-pdf /path/to/input.pdf > response.json
1919
'''
2020

2121
Option Strict On

VB.NET/Endpoint Examples/Multipart Payload/markdown.vb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
' For more information visit https://pdfrest.com/pricing#how-do-eu-gdpr-api-calls-work
1212
'
1313
' Usage (via dispatcher):
14-
' dotnet run --project VBNetSamples.vbproj -- markdown-multipart /path/to/input.pdf
14+
' dotnet run -- markdown-multipart /path/to/input.pdf
1515
'
1616
' Output:
1717
' - Prints the API JSON response to stdout. Non-2xx responses write a concise message to stderr and exit non-zero.
18-
' - Tip: pipe output to a file: dotnet run --project VBNetSamples.vbproj -- markdown-multipart /path/to/input.pdf > response.json
18+
' - Tip: pipe output to a file: dotnet run -- markdown-multipart /path/to/input.pdf > response.json
1919
'''
2020

2121
Option Strict On

VB.NET/Endpoint Examples/Multipart Payload/rasterized-pdf.vb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
' For more information visit https://pdfrest.com/pricing#how-do-eu-gdpr-api-calls-work
1212
'
1313
' Usage (via dispatcher):
14-
' dotnet run --project VBNetSamples.vbproj -- rasterized-pdf-multipart /path/to/input.pdf
14+
' dotnet run -- rasterized-pdf-multipart /path/to/input.pdf
1515
'
1616
' Output:
1717
' - Prints the API JSON response to stdout. Non-2xx responses write a concise message to stderr and exit non-zero.
18-
' - Tip: pipe output to a file: dotnet run --project VBNetSamples.vbproj -- rasterized-pdf-multipart /path/to/input.pdf > response.json
18+
' - Tip: pipe output to a file: dotnet run -- rasterized-pdf-multipart /path/to/input.pdf > response.json
1919
'''
2020

2121
Option Strict On

VB.NET/Program.vb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
' For more information visit https://pdfrest.com/pricing#how-do-eu-gdpr-api-calls-work
1212
'
1313
' Usage:
14-
' dotnet run --project VBNetSamples.vbproj -- <command> [args]
15-
' e.g., dotnet run --project VBNetSamples.vbproj -- markdown /path/to/input.pdf
14+
' dotnet run -- <command> [args]
15+
' e.g., dotnet run -- markdown /path/to/input.pdf
1616
'
1717
' Output:
1818
' - Each command prints the API JSON response to stdout. Non-2xx responses write a concise message to stderr and exit non-zero.

VB.NET/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ These VB.NET samples demonstrate how to call pdfRest APIs using HttpClient. A si
1616
- In `.env`, set `PDFREST_URL=https://eu-api.pdfrest.com`
1717
- More info: https://pdfrest.com/pricing#how-do-eu-gdpr-api-calls-work
1818

19-
3) Restore and build the project:
20-
- `dotnet restore VBNetSamples.vbproj`
21-
- `dotnet build VBNetSamples.vbproj`
19+
3) Restore and build the project (from this folder):
20+
- `dotnet restore`
21+
- `dotnet build`
2222

2323
4) Run a sample (examples below). The dispatcher pattern is:
24-
- `dotnet run --project VBNetSamples.vbproj -- <command> [args]`
24+
- `dotnet run -- <command> [args]`
2525

2626
## How It’s Organized
2727
- `VBNetSamples.vbproj`: single console app that compiles all VB samples in this folder.
@@ -34,19 +34,19 @@ These VB.NET samples demonstrate how to call pdfRest APIs using HttpClient. A si
3434
## Available Samples
3535
JSON two‑step (upload → operate via JSON):
3636
- `markdown` — Convert PDF to Markdown
37-
- Run: `dotnet run --project VBNetSamples.vbproj -- markdown /path/to/input.pdf`
37+
- Run: `dotnet run -- markdown /path/to/input.pdf`
3838
- `rasterized-pdf` — Rasterize a PDF
39-
- Run: `dotnet run --project VBNetSamples.vbproj -- rasterized-pdf /path/to/input.pdf`
39+
- Run: `dotnet run -- rasterized-pdf /path/to/input.pdf`
4040

4141
Multipart single request (send file directly):
4242
- `markdown-multipart` — Convert PDF to Markdown
43-
- Run: `dotnet run --project VBNetSamples.vbproj -- markdown-multipart /path/to/input.pdf`
43+
- Run: `dotnet run -- markdown-multipart /path/to/input.pdf`
4444
- `rasterized-pdf-multipart` — Rasterize a PDF
45-
- Run: `dotnet run --project VBNetSamples.vbproj -- rasterized-pdf-multipart /path/to/input.pdf`
45+
- Run: `dotnet run -- rasterized-pdf-multipart /path/to/input.pdf`
4646

4747
Complex flow:
4848
- `merge-different-file-types` — Merge multiple inputs (PDFs and non‑PDFs)
49-
- Run: `dotnet run --project VBNetSamples.vbproj -- merge-different-file-types file1.pdf file2.docx image.png`
49+
- Run: `dotnet run -- merge-different-file-types file1.pdf file2.docx image.png`
5050

5151
## Output & Error Handling
5252
- Successful calls print the API’s JSON response to stdout.
@@ -61,7 +61,7 @@ Complex flow:
6161
- .NET version:
6262
- Check with `dotnet --version`. Use .NET 8.0 or newer.
6363
- Clean build:
64-
- `rm -rf bin obj && dotnet build VBNetSamples.vbproj`
64+
- `rm -rf bin obj && dotnet build`
6565
- Proxy environments:
6666
- If your network requires a proxy, set standard environment variables like `HTTPS_PROXY`.
6767

0 commit comments

Comments
 (0)