TextBuffer description is missing in README

[sergei-dyshel]

At least some basic description (constructor and other basic methods which can not be deduced from index.js) would be helpful.

[Arcanemagus]

Thanks for taking the time to contribute!

We noticed that this is a duplicate of atom/atom#18308. You may want to subscribe there for updates.

Because we treat our issues list as the Atom team's backlog, we close duplicates to focus our work and not have to touch the same chunk of code for the same reason multiple times. This is also why we may mark something as duplicate that isn't an exact duplicate but is closely related.

For information on how to use GitHub's search feature to find out if something is a duplicate before filing, see the How Can I Contribute? section of the Atom CONTRIBUTING guide.

[Arcanemagus]

Or it's far too early in the morning and I confused this with something else, sorry!

[sergei-dyshel]

I'm being a little pedantic here: while I totally understand that superstring is part of Atom and it's alright that classes provided by it are documented in Atom API docs, it's also a standalone node package so one may use it without any relation to Atom (actually I do) so one may expect to have some standalone documentation for the module itself.

You already describe Patch and MarkerIndex in the README, why not describe TextBuffer too?

[Arcanemagus]

it's also a standalone node package so one may use it without any relation to Atom (actually I do) so one may expect to have some standalone documentation for the module itself.

I confused this with something else, sorry!

Again, I confused this issue with something entirely unrelated, sorry!

You already describe Patch and MarkerIndex in the README, why not describe TextBuffer too?

A PR adding this documentation would be wonderful!