From 3b85c0e910093aba94a7b29a92e6ce3493d88ae5 Mon Sep 17 00:00:00 2001 From: Martin Mahner Date: Sat, 23 Jun 2018 21:18:38 +0200 Subject: [PATCH] Updated Readme --- README.rst | 41 +++++++++++++++++++++++++++++------------ 1 file changed, 29 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index 30e8fea..6eeb32b 100644 --- a/README.rst +++ b/README.rst @@ -1,23 +1,40 @@ -.. image:: https://travis-ci.org/bartTC/dpaste.svg?branch=master - :target: https://travis-ci.org/bartTC/dpaste - -.. image:: https://api.codacy.com/project/badge/Coverage/185cfbe9b4b447e59a40f816c4a5ebf4 - :target: https://www.codacy.com/app/bartTC/dpaste?utm_source=github.com&utm_medium=referral&utm_content=bartTC/dpaste&utm_campaign=Badge_Coverage - -.. image:: https://api.codacy.com/project/badge/Grade/185cfbe9b4b447e59a40f816c4a5ebf4 - :target: https://www.codacy.com/app/bartTC/dpaste?utm_source=github.com&utm_medium=referral&utm_content=bartTC/dpaste&utm_campaign=Badge_Grade +.. _index: ====== dpaste ====== -dpaste is a Django based pastebin. It's intended to run separately but its also -possible to be installed into an existing Django project like a regular app. +.. image:: https://img.shields.io/pypi/v/dpaste.svg + :target: https://pypi.org/project/dpaste/ -You can find a live example on http://dpaste.de/ +.. image:: https://travis-ci.org/bartTC/dpaste.svg?branch=master + :target: https://travis-ci.org/bartTC/dpaste -Further documentation can be found here: https://docs.elephant.house/dpaste/ +.. image:: https://api.codacy.com/project/badge/Coverage/185cfbe9b4b447e59a40f816c4a5ebf4 + :target: https://www.codacy.com/app/bartTC/dpaste + +.. image:: https://api.codacy.com/project/badge/Grade/185cfbe9b4b447e59a40f816c4a5ebf4 + :target: https://www.codacy.com/app/bartTC/dpaste + + +dpaste is a pastebin_ application written in Python using the Django +framework. You can find a live installation on `dpaste.de`_. .. image:: https://raw.githubusercontent.com/bartTC/dpaste/master/docs/_static/dpaste_de_screenshot.png :alt: A screenshot of https://dpaste.de/ :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/bartTC/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.4** and **Django 1.11**. + +Further documentation can be found here: https://docs.elephant.house/dpaste/ + +.. _dpaste.de: https://dpaste.de/ +.. _pastebin: https://en.wikipedia.org/wiki/Pastebin