Update 'README.md'
minor readme fixes
This commit is contained in:
parent
a65a1e8733
commit
5dde150146
18
README.md
18
README.md
|
@ -8,21 +8,21 @@ You only need to install the base and whatever sub-modules you want to use
|
||||||
|
|
||||||
### From Git
|
### From Git
|
||||||
|
|
||||||
`$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-base&subdirectory=base"`
|
$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-base&subdirectory=base"
|
||||||
|
|
||||||
`$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-http-server&subdirectory=http_server"`
|
$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-http-server&subdirectory=http_server"
|
||||||
|
|
||||||
`$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-http-requests-client&subdirectory=requests_client"`
|
$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-http-requests-client&subdirectory=requests_client"
|
||||||
|
|
||||||
`$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-sql&subdirectory=sql"`
|
$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-sql&subdirectory=sql"
|
||||||
|
|
||||||
`$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-templates&subdirectory=template"`
|
$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-templates&subdirectory=template"
|
||||||
|
|
||||||
`$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-tinydb&subdirectory=tinydb"`
|
$(venv)/bin/python -m pip install -e "git+https://git.barkshark.xyz/izaliamae/izzylib.git@rework#egg=izzylib-tinydb&subdirectory=tinydb"
|
||||||
|
|
||||||
### From Source
|
### From Source
|
||||||
|
|
||||||
`$(venv)/bin/python setup.py install ['all' or a combination of these: http_server requests_client sql template tinydb]`
|
$(venv)/bin/python setup.py install ['all' or a combination of these: http_server requests_client sql template tinydb]
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
|
@ -32,11 +32,11 @@ Most useful classes and functions are imported in the module root, so you don't
|
||||||
|
|
||||||
This is fine:
|
This is fine:
|
||||||
|
|
||||||
`from izzylib import SqlDatabase`
|
from izzylib import SqlDatabase
|
||||||
|
|
||||||
and points to:
|
and points to:
|
||||||
|
|
||||||
`from izzylib.sql.generic import SqlDatabase`
|
from izzylib.sql.generic import SqlDatabase
|
||||||
|
|
||||||
Or even simply do `import izzylib` and use `izzylib.SqlDatabase()`.
|
Or even simply do `import izzylib` and use `izzylib.SqlDatabase()`.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue