Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #2

Open
Havvy opened this issue Nov 22, 2013 · 5 comments
Open

Documentation #2

Havvy opened this issue Nov 22, 2013 · 5 comments

Comments

@Havvy
Copy link

Havvy commented Nov 22, 2013

You're missing documentation (or links to your documentation) on both this repo and the the NPM page.

@kristianmandrup
Copy link

Agreed! At least put some of the tests in the README with some explanations or sth.
Also add basic install/config/usage info. Thanks

@msuarz
Copy link
Member

msuarz commented Mar 18, 2015

will do within the next few days
ty

@richardsimko
Copy link

Any update on the docs?

@factoidforrest
Copy link

factoidforrest commented Aug 18, 2016

any docs at all? If you want people to use your code, you have to document it

Edit:

This test is actually quite a bit better than no documentation at all. You can see things working:

https://github.com/limadelic/datomicjs/blob/master/test/datomic.coffee

You could even just put that as the documentation if you have no time for this project.

@kristianmandrup
Copy link

Check out this: https://github.com/kristianmandrup/datascript-tutorial

I will make it into a gitbook ASAP.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants