sanctuary-js / sanctuary-def

Run-time type system for JavaScript
MIT License
293 stars 24 forks source link

readme: integrate Transcribe #97

Closed davidchambers closed 7 years ago

davidchambers commented 7 years ago

For quite some time it has bothered me that sanctuary-def does not use Transcribe as all the other Sanctuary projects do. Now that we have sanctuary.js.org it's particularly important that all the projects are documented in the same manner: it will allow us to use generate to publish all the Sanctuary projects on the website, not just Sanctuary itself.

This pull request copies the documentation to index.js. From this point forward we will no longer update README.md directly. In order to get an idea of the changes that will be made to README.md when we release sanctuary-def@0.7.0, I've included a proof. I'll revert the changes to README.md before merging this pull request.

:memo: