Skip to content

Commit

Permalink
chore: fix prettier errors
Browse files Browse the repository at this point in the history
Signed-off-by: Gustav Grusell <[email protected]>
  • Loading branch information
grusell committed Jun 17, 2024
1 parent e7a10de commit 1363685
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 8 deletions.
1 change: 0 additions & 1 deletion .github/workflows/publish-docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,3 @@ jobs:
push: true
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}

27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@
CLI and library for creating a streaming bundle from an ABR bundle [shaka-packager](https://github.com/shaka-project/shaka-packager). Input and output can be in S3 buckets.

## Requirements

shaka-packager executable must be available in path under the name `packager`. When using S3 for input and output the AWS CLI must be installed and configured.

## Usage

### CLI

```
> npm install -g shaka-packager-s3
> shaka-packager-s3 s3://source-bucket/folder s3://output-bucket/folder -i a:1=audio.mp4 -i v:1=video.mp4
Expand All @@ -15,25 +18,34 @@ shaka-packager executable must be available in path under the name `packager`. W
```

### Library

```javascript
import { Input, doPackage } from '@eyevinn/shaka-packager-s3';

const inputs = [{
const inputs = [
{
type: 'audio',
key: '1',
filename: 'audio.mp4'
}, {
},
{
type: 'video',
key: '1',
filename: 'video.mp4'
}];
}
];

const dest = '/my/output/folder';
doPackage({
dest,
inputs,
}).then(() => {console.log('done')}).catch((err) => {console.error(err)});

dest,
inputs
})
.then(() => {
console.log('done');
})
.catch((err) => {
console.error(err);
});
```

### Docker
Expand All @@ -60,6 +72,7 @@ docker run --rm \
## Development

Prerequisites:

- shaka-packager
- AWS cli

Expand Down

0 comments on commit 1363685

Please sign in to comment.