adrest icon indicating copy to clipboard operation
adrest copied to clipboard

Add basic documentation

Open dokterbob opened this issue 12 years ago • 1 comments

The actual code of this package looks very useful at first sight in comparison with tastypie and djangrestframework, as it seems to be more flexible than both and has a good middleway when it comes to coding practises.

However, it having no documentation whatsoever makes it an unacceptable choice in any development project. So please try to explain at least:

  • What adrest is doing
  • How it is doing it (ie. main concepts, resources, registration, mixins etc.)
  • How this compares to existing API frameworks

And preferably: how to get started with builing an API. Also, knowing the level of automated testing used during development is good to, at least, evaluate it.

--- Want to back this issue? **[Post a bounty on it!](https://www.bountysource.com/issues/1428283-add-basic-documentation?utm_campaign=plugin&utm_content=tracker%2F340801&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F340801&utm_medium=issues&utm_source=github).

dokterbob avatar Jul 08 '12 08:07 dokterbob

Thanks for the feedback. You are certainly right. But the module was developed for myself and I do not attach any importance to documentation. I'll do it as soon as I can.

klen avatar Jul 08 '12 09:07 klen