Hopiu/djLint
1
0
Fork 0
mirror of https://github.com/Hopiu/djLint.git synced 2026-03-16 21:40:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

added usage to readme

Browse source
This commit is contained in:
Christopher Pickering 2021-07-30 08:56:31 -05:00
parent 5238377f8b
commit 9d2031b38a
No known key found for this signature in database
GPG key ID: E14DB3B0A0FACF84
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -10,6 +10,26 @@ Ps, ```--check``` it out on Jinja and Handlebar templates as well!
Read the [documentation](https://djlint.readthedocs.io)
## Installation and Usage
djLint can be installed with `pip install djlint`, and is easy to run:
```sh
# to lint a directory
djlint /path
# to lint a directory with custom extension
djlint /path -e html.dj
# to check formatting on a file
djlint /path/file.html.j2 --check
# to reformt a directory without printing the file diff
djlint /path --reformat --quiet
```
## Show your format
Add a badge to your projects ```readme.md```: