readable icon indicating copy to clipboard operation
readable copied to clipboard

Document code structure and implementation

Open waldyrious opened this issue 2 years ago • 0 comments

This is similar to #4, but instead of describing just the goals and motivation of the project (the "what" and "why"), this issue focuses on the "how".

Specifically, it would be nice to have an overview of that the code does and how it works. This documentation could live in README.md or in CONTRIBUTING.md (or both). I would expect at least a link to https://github.com/bobheadxi/readable/blob/main/plugins/readable/reflow.ts, which, if I understand correctly, is core of the project.

waldyrious avatar Nov 24 '23 12:11 waldyrious