sodiray / dynofunc

Functional library for creating and sending dynamo requests on top of boto3
MIT License
9 stars 3 forks source link

Simplify + improve the docs #6

Open sodiray opened 4 years ago

sodiray commented 4 years ago

Our docs are many... so much so I think they're unhelpful. Let's simplify. Possibly remove the api documentation... I don't think it's helpful. When introducing new users to dynamof we should start with an example where we only use an operation function (like query) to build the boto3 description. Show them the result of that call and what it does, describe that this is the core function of dynamof. Then we can show them the use of the execute and the extra layer it adds.