Skip to content

Commit ab92898

Browse files
author
Transcript Dock
committed
docs: add public registry install instructions
1 parent 779d527 commit ab92898

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
# Transcript Dock for PHP
22

33
A synchronous API client for PHP 8.1 or newer. Requires the PHP cURL and JSON
4-
extensions, with no third party runtime packages. Version 0.1.0.
4+
extensions, with no third party runtime packages. Version 0.1.0 is available on
5+
[Packagist](https://packagist.org/packages/transcriptdock/transcriptdock).
56

6-
Use Composer's path repository feature during local development, or load the
7-
three source files directly:
7+
Install with Composer:
8+
9+
```sh
10+
composer require transcriptdock/transcriptdock:0.1.0
11+
```
812

913
```php
10-
require 'src/ApiError.php';
11-
require 'src/JobTimeoutError.php';
12-
require 'src/Client.php';
14+
require 'vendor/autoload.php';
1315

1416
$client = new TranscriptDock\Client(getenv('TRANSCRIPTDOCK_API_KEY'));
1517
// Generate once per intended operation and save with the returned job ID.
@@ -24,9 +26,8 @@ if ($job['status'] === 'succeeded') {
2426
}
2527
```
2628

27-
Composer autoloading maps `TranscriptDock\\` to `src/`. Install into a local
28-
application through a Composer `path` repository pointing to this directory,
29-
then require `transcriptdock/transcriptdock` with the local version constraint.
29+
Composer autoloading maps `TranscriptDock\\` to `src/`. During local
30+
development, a Composer `path` repository can point to this directory.
3031

3132
Creating a job can spend credits. The example requests captions only with a
3233
one credit ceiling and does not enable AI fallback. Save the key and reuse the

0 commit comments

Comments
 (0)