Update readme to MD format

This commit is contained in:
Darren 2022-01-10 12:50:10 -05:00 committed by GitHub
parent f263d3c67b
commit d324f0058e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 36 deletions

23
README.md Normal file
View file

@ -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

View file

@ -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