danprince / zaphod

🌌 Clojure's API for JavaScript's Objects
https://zaphod.surge.sh
MIT License
54 stars 1 forks source link

Structured introduction to docs #9

Closed danprince closed 8 years ago

danprince commented 8 years ago

Opening gambit should answer these questions:

  1. What is this thing?
  2. Why should I care?
  3. Is it worth the effort?

Short guide:

  1. Installing with npm
  2. Importing into project
  3. Using babel stage-0
  4. Getting immutable

Set the landscape:

  1. What's the license?
  2. Where are issues?
  3. Where is the source code?
  4. Where are the docs?
  5. Where can I get support? (Gitter/Stack Overflow)

What next?

  1. Keyed Collection Methods
  2. Indexed Collection Methods
  3. Functional Utilities