Skip to content

Reorganize README #672

Closed
Closed
@danburzo

Description

@danburzo

I'd like to attempt reorganizing the README and include more details on the following:

  • The constructor options
  • The shape of the object returned by Readability.parse()
  • The Readability.isReaderable() function
  • Usage in the browser vs. Node.js

I thought I'd open an issue to get confirmation before starting a PR.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions