Skip to content

Commit 2b9561e

Browse files
committed
[ci skip]chore(docs): improve readme
1 parent ecb7186 commit 2b9561e

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Static conformity is largely used in the dev world but there is no such tool for
44
This tool connect to a postgres database to check good practices in schema design and output a file in [Sarif][2] format.
55
A configuration file describe the rule to enforce and acceptable threshold
66

7+
An example of the output is: ![dblinter output](docs/dblinter-output.png)
8+
79
## Launch dblinter
810

911
### Docker
@@ -16,6 +18,19 @@ Launch the docker image
1618
docker run --rm -t decathlon/dblinter:latest --dbname $PGDATABASE --host $PGHOST --user $PGUSER --password $PGPASSWORD --port $PGPORT
1719
```
1820

21+
## Directly from the source
22+
23+
You can launch dblinter directly from the source code. You will need python and poetry to install the dependencies:
24+
25+
```shell
26+
# Install poetry
27+
curl -sSL https://install.python-poetry.org | python3 -
28+
# Install dependencies
29+
poetry install --with dev
30+
# Launch the program
31+
poetry run python -m dblinter --dbname $PGDATABASE --host $PGHOST --user $PGUSER --password $PGPASSWORD --port $PGPORT
32+
```
33+
1934
## Usage
2035

2136
```shell

docs/dblinter-output.png

108 KB
Loading

0 commit comments

Comments
 (0)