jbochi / lua-resty-cassandra

Pure Lua Cassandra client using CQL binary protocol

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Better documentation

jbochi opened this issue · comments

A lot of features are not described in the readme (paging, batch support, all type annotation functions, etc)

Should we have a wiki? Create a website? Just update the readme?

👍 for the README update. Also, the method themselves could use some documentation. I will try to write some.

I started to update the documentation on this branch.

The layout is an attempt, if you don't like it, let me know.

We also need a changelog file.

Awesome! Feel free to send another pull request.

And yes, we definitely need a changelog.