search

octabytes / FireO

Google Cloud Firestore modern and simplest convenient ORM package in Python. FireO is specifically designed for the Google's Firestore
https://fireo.octabyte.io
Apache License 2.0
250 stars 29 forks source link

Provide a better documentation #12

Closed derekleegh closed 5 years ago

derekleegh commented 5 years ago

Hi ,

First of all, thank you creating a ORM library for Firebase!

Appreciate if you can provide better documentation? Like how to inherit the Model class?

Like how do you import the TextField and etc. I mainly have to figure it out by diving into your tests and have a look how its implemented. It will be better if you can have a clearer documentation for at least the basic steps of creating an ORM.

Cheers

AxeemHaider commented 5 years ago

Thanks for feedback. Actual documentation is available here https://octabyte.io/FireO/ But we will update our docs regarding what you are saying.