From 3a0df8c4ead0b37066dcec5b8af364fd219d4446 Mon Sep 17 00:00:00 2001 From: peppelinux Date: Mon, 5 Apr 2021 00:50:48 +0200 Subject: [PATCH] README --- .github/workflows/python-package.yml | 6 +++--- README.md | 8 +++----- setup.py | 3 ++- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml index c04d8d5a..6d5c6558 100644 --- a/.github/workflows/python-package.yml +++ b/.github/workflows/python-package.yml @@ -28,8 +28,8 @@ jobs: run: | sudo apt-get update && sudo apt-get install xmlsec1 python -m pip install --upgrade pip tox rstcheck setuptools codecov - - name: Readme check - if: ${{ matrix.python-version }} == 3.8 && ${{ matrix.django-version }} == "3.0" - run: rstcheck README.rst + #- name: Readme check + #if: ${{ matrix.python-version }} == 3.8 && ${{ matrix.django-version }} == "3.0" + #run: rstcheck README.rst - name: Tests run: tox -e py${{ matrix.python-version }}-django${{ matrix.django-version }} diff --git a/README.md b/README.md index cf01cdc8..8ce6dc28 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ djangosaml2 =========== -![CI build](https://github.com/peppelinu/djangosaml2/workflows/djangosaml2/badge.svg) +![CI build](https://github.com/peppelinux/djangosaml2/workflows/djangosaml2/badge.svg) ![Python version](https://img.shields.io/badge/license-Apache%202-blue.svg) ![License](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9-blue.svg) @@ -12,7 +12,7 @@ A Django application that builds a Fully Compliant SAML2 Service Provider on top This document will guide you through a few simple steps to accomplish such goal. -Please consult the `official Documentation of djangosaml2 <>`_ to get started. +Please consult the [official Documentation of djangosaml2](https://djangosaml2.readthedocs.io/en/latest/) to get started. Contributing @@ -32,11 +32,9 @@ Special thanks The story of this project is a community-driven project, born as a fork of another project and maintained by different authors at different times, such as: - - [Lorenzo Gil Sanchez](https://github.com/lorenzogil) - [Jozef knaperek](https://github.com/knaperek) -- me -A special thank to Jozef for having maintained this project with passion and diligence until the birth of version v1.0 and not least for allowing me to take the reins of all this. +A special thank to Jozef for having maintained this project with passion and diligence until the birth of version v0.19.0 and not least for allowing me to take the reins of all this. A special thank to [Mathieu Hinderyckx](https://github.com/mhindery) for having give an important contribution to v1.0. I'd like to thank all the contributors, one by one, for the color and creativity with which they have enriched this project and will continue to do so. diff --git a/setup.py b/setup.py index f4591cad..a848f3c6 100644 --- a/setup.py +++ b/setup.py @@ -26,7 +26,8 @@ def read(*rnames): name='djangosaml2', version='1.1.0', description='pysaml2 integration for Django', - long_description=read('README.rst'), + long_description=read('README.md'), + long_description_content_type='text/markdown', classifiers=[ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment",