Update Readme to reflect custom events

[tamb]

Current custom events should be added to API section.

I propose we define the structure for docs like:

API

• Hook 1

• Custom Event 1

• Hook 2

• Custom Event 2

[rumkin]

I think the standard here is to add Events section into the API's and to add links to events into hooks and vice versa. Like MDN does (example HTMLFormElement).

[tamb]

@rumkin Gotcha. So a separate section but hooks and events should link to each other. 👍

[rumkin]

This is a proposal from #32 issue. To restructure documentation originally provided by @tamb:

I believe the API sections needs to be restructured as such:

API

Hooks

pillOptions.onReady() etc...

Custom Events (when merged)

---

And it might look like so:

I believe the API sections needs to be restructured as such:

---

API

Hooks

onReady() Hook

(ref to pill:ready event)

Events

pill:ready Event

(ref to onReady() hook)

Options

PillOptions.onReady()

Option description.

(ref to onReady() hook)

---

• – Sections Hooks, Events and Options could follow in other order.