doc: README: add python module usage

pajachiet / pymongo-schema

A schema analyser for MongoDB, written in Python.

GNU Lesser General Public License v3.0

74 stars 13 forks source link

doc: README: add python module usage #27

Closed JulieRossi closed 7 years ago

JulieRossi commented 7 years ago

Just a small PR to improve README.

@pajachiet do you think python usage should be more detailed ?

I was thinking maybe export submodule should be renamed transform to be consistent with CLI ?

coveralls commented 7 years ago

Coverage remained the same at 92.661% when pulling 44bb00fbd578988aa47ce0c2712cceb35c60c897 on julie/readme into badd9cf04ed75cd1dc14c16e88fbee2feae35fbf on master.

pajachiet commented 7 years ago

Good idea this PR. I think usage should be concise, so its great as is. But their should be python examples below.

We could

rename "easy example" section to "bash api examples" (and finish the section)
add a "python api examples" section
delete "example" section