From 8e7d2d311246991f84dc5196ea6e31b2379a4bff Mon Sep 17 00:00:00 2001 From: Christopher Pickering Date: Thu, 29 Jul 2021 14:12:14 -0500 Subject: [PATCH] changed to md --- README.md | 35 +++++++++++++++++++++++++++++++++++ README.rst | 52 ---------------------------------------------------- setup.py | 4 ++-- 3 files changed, 37 insertions(+), 54 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..b47d6a4 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# djLint + +Simple html template linter and reformatter to find common formatting issues with and *reformat* django html templates + +Ps, ```--check``` it out on Jinja and Handlebar templates as well! + +[![codecov](https://codecov.io/gh/Riverside-Healthcare/djlint/branch/master/graph/badge.svg?token=eNTG721BAA)](https://codecov.io/gh/Riverside-Healthcare/djlint) [![test](https://github.com/Riverside-Healthcare/djlint/actions/workflows/test.yml/badge.svg)](https://github.com/Riverside-Healthcare/djlint/actions/workflows/test.yml) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/dba6338b0e7a4de896b45b382574f369)](https://www.codacy.com/gh/Riverside-Healthcare/djlint/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Riverside-Healthcare/djlint&utm_campaign=Badge_Grade) [![Maintainability](https://api.codeclimate.com/v1/badges/5febe4111a36c7e0d2ed/maintainability)](https://codeclimate.com/github/Riverside-Healthcare/djlint/maintainability) + + +## Documentation + +Read the [documentation](https://djlint.readthedocs.io) + +## Show your format + +Add a badge to your projects ```readme.md```: + +```md +[![Code style: black](https://img.shields.io/badge/html%20style-djlint-blue.svg)](https://github.com/Riverside-Healthcare/djlint) +``` + +Add a badge to your ```readme.rst```: + +```rst +.. image:: https://img.shields.io/badge/html%20style-djlint-blue.svg + :target: https://github.com/Riverside-Healthcare/djlint +``` +Looks like this: + +[![djlint](https://img.shields.io/badge/html%20style-djlint-blue.svg)](https://github.com/Riverside-Healthcare/djlint) + + +## Contributing - Please Help! + +Checkout the [issue](https://github.com/Riverside-Healthcare/djlint/issues) list and help where you can! diff --git a/README.rst b/README.rst deleted file mode 100644 index ec3f36c..0000000 --- a/README.rst +++ /dev/null @@ -1,52 +0,0 @@ -djLint -====== - -Simple html template linter and reformatter to find common formatting issues with and *reformat* django html templates - -Ps, ``--check`` it out on Jinja and Handlebar templates as well! - -|codecov| |test| |Codacy Badge| |Maintainability| - - -Documentation -------------- - -Read the `documentation `_ - -Show your format ----------------- - -Add a badge to your projects `readme.md`: - -.. code-block:: md - - [![Code style: black](https://img.shields.io/badge/html%20style-djlint-blue.svg)](https://github.com/Riverside-Healthcare/djlint) - - -Add a badge to your `readme.rst`: - -.. code-block:: rst - - .. image:: https://img.shields.io/badge/html%20style-djlint-blue.svg - :target: https://github.com/Riverside-Healthcare/djlint - - -Looks like this: - -.. image:: https://img.shields.io/badge/html%20style-djlint-blue.svg - :target: https://github.com/Riverside-Healthcare/djlint - - -Contributing - Please Help! ---------------------------- - -Checkout the `issue `_ list and help where you can! - -.. |codecov| image:: https://codecov.io/gh/Riverside-Healthcare/djlint/branch/master/graph/badge.svg?token=eNTG721BAA - :target: https://codecov.io/gh/Riverside-Healthcare/djlint -.. |test| image:: https://github.com/Riverside-Healthcare/djlint/actions/workflows/test.yml/badge.svg - :target: https://github.com/Riverside-Healthcare/djlint/actions/workflows/test.yml -.. |Codacy Badge| image:: https://app.codacy.com/project/badge/Grade/dba6338b0e7a4de896b45b382574f369 - :target: https://www.codacy.com/gh/Riverside-Healthcare/djlint/dashboard?utm_source=github.com&utm_medium=referral&utm_content=Riverside-Healthcare/djlint&utm_campaign=Badge_Grade -.. |Maintainability| image:: https://api.codeclimate.com/v1/badges/5febe4111a36c7e0d2ed/maintainability - :target: https://codeclimate.com/github/Riverside-Healthcare/djlint/maintainability diff --git a/setup.py b/setup.py index d9cbb03..e4386e0 100644 --- a/setup.py +++ b/setup.py @@ -12,7 +12,7 @@ __version__ = "0.1.2" def long_description(): """Build long description from readme and changelog.""" return ( - (project_path / "README.rst").read_text(encoding="utf8") + (project_path / "README.md").read_text(encoding="utf8") + "\n\n" + (project_path / "CHANGELOG.md").read_text(encoding="utf8") ) @@ -31,7 +31,7 @@ setup( author_email="cpickering@rhc.net", description="Django Template Linter", long_description=long_description(), - long_description_content_type="text/x-rst", + long_description_content_type="text/markdown", url="https://github.com/Riverside-Healthcare/djlint", include_package_data=True, package_data={"djlint": ["rules.yaml"]},