search

day8 / re-com

A ClojureScript library of reusable components for Reagent
https://re-com.day8.com.au
MIT License
798 stars 147 forks source link

Note about api namespace in docs #86

Closed metasoarous closed 7 years ago

metasoarous commented 8 years ago

I can't find anywhere in the docs or the re-com demo introduction anywhere that the api namespace is re-com.core. I know it's easy enough to figure out by looking at the repo, but that's one of the first things I usually look after the clojars coords, so it would be nice if it was visible :-)

Gregg8 commented 7 years ago

Do you have a suggestion for where this information should live? And how much detail would you expect to see? Link to any examples?

metasoarous commented 7 years ago

A short section near the top of the introduction page would suffice. Something like:

Getting started

First add the coordinates [re-com "0.9.0"] to your project.clj dependencies. You should now be able to require the re-com.core namespace, which exposes all of the API functions documented in this example app.

Gregg8 commented 7 years ago

OK, this has been added and will appear in the next release, which should be ready in a short while.