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.

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

Update README supported and unsupported Features section #3479

Merged
merged 3 commits into from
Feb 15, 2021

Conversation

robwalch
Copy link
Collaborator

@robwalch robwalch commented Feb 12, 2021

This PR will...

Update README supported and unsupported Features section:

  • Moved or added notes for tags that we parse and list under Supported, but do not support functionally. For Example:
The following tags are added to their respective fragment's attribute list but are not
implemented in streaming and playback
  - #EXT-X-GAP (Not implemented. See #2940)
  • Moved Not Supported (Yet) to Not Supported under Features
  • Moved Server-side-rendering (SSR)... to follow Not Supported and updated the description to explicitly state that only a dummy object is exported in node.js and that hls.js is not instantiable in that runtime.
  • Updated the hls.js spec link to draft-pantos-hls-rfc8216bis-08
  • Added JW Player to Player Integration
  • Moved They use hls.js in production! under Player Integration

Clean up prettier ignore and remove bower config.

Why is this Pull Request needed?

The Features section is an important resource for understanding what hls.js does and does not support.

Prettier should not clean up files generated in the /lib directory.

We no longer publish to bower.

Are there any points in the code the reviewer needs to double check?

  • Are there any other HLS tags or sections of the spec not covered in the Not Supported section?
  • Are there any other open issues or pull-requests worth covering in the Not Supported section?

I'll take suggestions for enhancing the supported features section, but adding features or additional writing beyond any missing tags or attributes is outside the scope of this PR.

Checklist

  • changes have been done against master branch, and PR does not conflict
  • new unit / functional tests have been added (whenever applicable)
  • API or design changes are documented in API.md

@robwalch robwalch force-pushed the task/readme-supported-features branch 3 times, most recently from 60be2b1 to d806a4a Compare February 14, 2021 09:54
tjenkinson
tjenkinson previously approved these changes Feb 14, 2021
Copy link
Member

@tjenkinson tjenkinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Are there any other HLS tags or sections of the spec not covered in the Not Supported section?

Are there any other open issues or pull-requests worth covering in the Not Supported section?

I haven't checked these though

.prettierignore Outdated Show resolved Hide resolved
tjenkinson
tjenkinson previously approved these changes Feb 14, 2021
@robwalch robwalch force-pushed the task/readme-supported-features branch from ce34062 to 40400df Compare February 15, 2021 23:11
@robwalch robwalch merged commit fe29a49 into master Feb 15, 2021
@robwalch robwalch deleted the task/readme-supported-features branch February 15, 2021 23:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants