ToC in readme

[sanctuary-js]

ToC in readme

[davidchambers]

A table of contents would be useful, certainly. Listing every function is perhaps unnecessary, but it would be great to list the sections and to be able to jump to a particular section. :)

If we decide not to list every function, we may not need to introduce a dependency:

$ sed -e '/^#\{2,3\} /!d' -e 's/^###/    -/' -e 's/^##/  -/' README.md
  - Types
    - Accessible pseudotype
    - Integer pseudotype
    - List pseudotype
    - Type representatives
  - API
    - Classify
    - Combinator
    - Function
    - Composition
    - Maybe type
    - Either type
    - Alternative
    - Logic
    - List
    - Object
    - Parse
    - RegExp
    - String

It's worth noting that I've begun work on a website for Sanctuary, though this is an orthogonal issue as the readme would benefit from a table of contents irrespective of whether there exists a website which presents the information more effectively.

[davidchambers]

Now that we have sanctuary-js/sanctuary-site#13 I don't think it's necessary to update the readme as well. The nice thing about having the readme on GitHub is that it provides documentation for Sanctuary versions prior to the current one. The website is the best place to learn about the current Sanctuary version, though, as it has interactive usage examples. :)