From d324f0058ee0bc46a9b0409f982f9cc2a064d62e Mon Sep 17 00:00:00 2001 From: Darren Date: Mon, 10 Jan 2022 12:50:10 -0500 Subject: [PATCH] Update readme to MD format --- README.md | 23 +++++++++++++++++++++++ README.rst | 36 ------------------------------------ 2 files changed, 23 insertions(+), 36 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..c8aa699 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +Dpaste +--- +![dpaste image](https://img.shields.io/pypi/v/dpaste.svg) +![building](https://travis-ci.org/bartTC/dpaste.svg?branch=master) +![Code Quality](https://api.codacy.com/project/badge/Grade/185cfbe9b4b447e59a40f816c4a5ebf4) + +---- + +📖 Full documentation on [https://docs.dpaste.org](https://docs.dpaste.org) + + +dpaste is a [pastebin](https://en.wikipedia.org/wiki/Pastebin) application written in [Python](https://www.python.org/) using the [Django](https://www.djangoproject.com/) framework. You can find a live installation on [dpaste.org.](https://dpaste.org) + +The project is intended to run standalone as any regular Django Project, but it's also possible to install it into an existing project as a typical Django application. + + +The code is open source and available on Github: [https://github.com/darrenofficial/dpaste](https://github.com/darrenofficial/dpaste). If you found bugs, have problems or ideas with the project or the website installation, please create an *Issue* there. + +⚠️ dpaste requires at a minimum Python 3.6 and Django 2.2. + + +dpaste.org: https://dpaste.org/ +pastebin: https://en.wikipedia.org/wiki/Pastebin diff --git a/README.rst b/README.rst deleted file mode 100644 index 7770b1b..0000000 --- a/README.rst +++ /dev/null @@ -1,36 +0,0 @@ -====== -dpaste -====== - -.. image:: https://img.shields.io/pypi/v/dpaste.svg - :target: https://pypi.org/project/dpaste/ - -.. image:: https://github.com/DarrenOfficial/dpaste/actions/workflows/building.yml/badge.svg - :target: https://github.com/DarrenOfficial/dpaste/blob/master/.github/workflows/building.yml - -.. image:: https://api.codacy.com/project/badge/Grade/185cfbe9b4b447e59a40f816c4a5ebf4 - :target: https://www.codacy.com/app/bartTC/dpaste - ----- - -📖 Full documentation on https://docs.dpaste.org - -dpaste is a pastebin_ application written in Python using the Django -framework. You can find a live installation on `dpaste.org`_. - -.. image:: https://cdn.darrennathanael.com/assets/dpaste/dpaste.png - :alt: A screenshot of https://dpaste.org/ - :width: 60% - -The project is intended to run standalone as any regular Django Project, -but it's also possible to install it into an existing project as a typical -Django application. - -The code is open source and available on Github: https://github.com/DarrenOfficial/dpaste. -If you found bugs, have problems or ideas with the project or the website installation, -please create an *Issue* there. - -⚠️ dpaste requires at a minimum Python 3.6 and Django 2.2. - -.. _dpaste.org: https://dpaste.org/ -.. _pastebin: https://en.wikipedia.org/wiki/Pastebin