On Fri, Mar 30, 2018 at 3:31 AM Vincent den Boer <[email protected]> wrote:

> As far as I've understood from the overview, Annotator's main job for now
> is to convert selectors into anchors, and vice-versa, right?


Correct.


> Are there any more docs?


Not yet. Sorry! The API is still stabilizing.


> And since I see no "index" keyin the package.json, is it already meant to
> be used as a package?


It is many packages.

The package.json sets up yarn workspaces and installs common development
tooling used for all the packages. The top level is not, itself, a package
and will never be published to npm. The packages are all in the "packages"
directory.


> If so, what can we expect in terms of API stability?
>

You can expect semantic versioning. We'll break API as often as we need to,
but not carelessly. If we ship a release and you are are actively depending
on an older version, we will welcome your help!

I don't think it's reasonable to expect every volunteer to help maintain
multiple versions, but if there is a demand for back-porting and lingering
support for old versions we will welcome help in doing so.

Reply via email to