From 86b66a3c853f990ded427928d31acf76c79cb9b3 Mon Sep 17 00:00:00 2001 From: Ben Firshman Date: Fri, 31 Oct 2014 13:48:35 +0000 Subject: Rename "README" to "README.rst" So GitHub makes it pretty. --- README | 102 ------------------------------------------------------------- README.rst | 102 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 102 insertions(+), 102 deletions(-) delete mode 100644 README create mode 100644 README.rst diff --git a/README b/README deleted file mode 100644 index 2f5e857..0000000 --- a/README +++ /dev/null @@ -1,102 +0,0 @@ -django-shorturls -================ - -.. image:: https://travis-ci.org/bfirsh/django-shorturls.svg?branch=master - :target: https://travis-ci.org/bfirsh/django-shorturls -.. image:: https://badge.fury.io/py/django-shorturls.svg - :target: http://badge.fury.io/py/django-shorturls - -A custom URL shortening app for Django, including easy ``rev=canonical`` -support. - -Most code was originally by Simon Willison; see -http://simonwillison.net/2009/Apr/11/revcanonical/ for details. Improved -slightly and packaged by Jacob Kaplan-Moss. - -Patches welcome: http://github.com/jacobian/django-shorturls - -Usage -===== - -So, you want to host your own short URLs on your Django site: - -1. In your settings, define a set of prefixes for short URLs:: - - SHORTEN_MODELS = { - 'A': 'myapp.animal', - 'V': 'myapp.vegetable', - 'M': 'myapp.mineral' - } - - The keys are string prefixes; they can be any string, actually, - but since we're going for short a single character is probably good. - - Values are the (hopefully-familiar) ``"."`` used - by Django to identify a model. Remember: ``app-name`` is the - (case-sensitive) last bit of your app's name in ``INSTALLED_APPS``, and - ```` is your model class's name, lowercased. - - Make sure your models have a ``get_absolute_url()`` method defined. - -2. Wire up the redirect view by adding to your URLconf:: - - ('^short/', include('shorturls.urls')) - -3. If you'd like to quickly link to shortened URLs in your templates, stick - ``"shorturls"`` in ``INSTALLED_APPS``, and then in your templates do:: - - {% load shorturl %} - ... - - (where ``object`` is a model instance). - - Alternatively:: - - {% load shorturl %} - {% revcanonical object %} - - This generates the whole ```` tag for - you. - -That's it. - -If you'd like more control, keep reading. - -Settings -======== - -Available settings are: - -``SHORTEN_MODELS`` - You've seen this one. - -``SHORT_BASE_URL`` - If defined, the ``shorturl`` and ``revcanonical`` template tags will - prefix generated URLs with this value. Use this if you've got a shorter - domain name you'd like to use for small URLs. - - For example, given ``SHORT_BASE_URL = 'http://exm.pl/'``, ``{% shorturl - obj %}`` would return something like ``http://exm.pl/AbCd``. - -``SHORTEN_FULL_BASE_URL`` - The domain to redirect to when redirecting away from the small URL. - Again, you'll use this if your short URL base and your "real" site - differ. - - If not defined, the redirect view will try to guess the proper domain by - consulting the ``django.contrib.sites`` framework, if installed, or the - requested domain, if not. - - -``SHORTURLS_DEFAULT_CONVERTER`` - The converter that is used to translate between short URLs and model IDs. - Defaults to the built in base 62 conversion. - - Available converters: - - - ``shorturls.baseconv.base62`` Base 62 encoding. - - ``shorturls.baseconv.base32`` `Douglas Crockford's base 32`_. - - ``shorturls.baseconv.hexconv`` Hex encoding. - - ``shorturls.baseconv.bin`` Binary encoding, because why not. - -.. _Douglas Crockford's base 32: http://www.crockford.com/wrmg/base32.html diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..2f5e857 --- /dev/null +++ b/README.rst @@ -0,0 +1,102 @@ +django-shorturls +================ + +.. image:: https://travis-ci.org/bfirsh/django-shorturls.svg?branch=master + :target: https://travis-ci.org/bfirsh/django-shorturls +.. image:: https://badge.fury.io/py/django-shorturls.svg + :target: http://badge.fury.io/py/django-shorturls + +A custom URL shortening app for Django, including easy ``rev=canonical`` +support. + +Most code was originally by Simon Willison; see +http://simonwillison.net/2009/Apr/11/revcanonical/ for details. Improved +slightly and packaged by Jacob Kaplan-Moss. + +Patches welcome: http://github.com/jacobian/django-shorturls + +Usage +===== + +So, you want to host your own short URLs on your Django site: + +1. In your settings, define a set of prefixes for short URLs:: + + SHORTEN_MODELS = { + 'A': 'myapp.animal', + 'V': 'myapp.vegetable', + 'M': 'myapp.mineral' + } + + The keys are string prefixes; they can be any string, actually, + but since we're going for short a single character is probably good. + + Values are the (hopefully-familiar) ``"."`` used + by Django to identify a model. Remember: ``app-name`` is the + (case-sensitive) last bit of your app's name in ``INSTALLED_APPS``, and + ```` is your model class's name, lowercased. + + Make sure your models have a ``get_absolute_url()`` method defined. + +2. Wire up the redirect view by adding to your URLconf:: + + ('^short/', include('shorturls.urls')) + +3. If you'd like to quickly link to shortened URLs in your templates, stick + ``"shorturls"`` in ``INSTALLED_APPS``, and then in your templates do:: + + {% load shorturl %} + ... + + (where ``object`` is a model instance). + + Alternatively:: + + {% load shorturl %} + {% revcanonical object %} + + This generates the whole ```` tag for + you. + +That's it. + +If you'd like more control, keep reading. + +Settings +======== + +Available settings are: + +``SHORTEN_MODELS`` + You've seen this one. + +``SHORT_BASE_URL`` + If defined, the ``shorturl`` and ``revcanonical`` template tags will + prefix generated URLs with this value. Use this if you've got a shorter + domain name you'd like to use for small URLs. + + For example, given ``SHORT_BASE_URL = 'http://exm.pl/'``, ``{% shorturl + obj %}`` would return something like ``http://exm.pl/AbCd``. + +``SHORTEN_FULL_BASE_URL`` + The domain to redirect to when redirecting away from the small URL. + Again, you'll use this if your short URL base and your "real" site + differ. + + If not defined, the redirect view will try to guess the proper domain by + consulting the ``django.contrib.sites`` framework, if installed, or the + requested domain, if not. + + +``SHORTURLS_DEFAULT_CONVERTER`` + The converter that is used to translate between short URLs and model IDs. + Defaults to the built in base 62 conversion. + + Available converters: + + - ``shorturls.baseconv.base62`` Base 62 encoding. + - ``shorturls.baseconv.base32`` `Douglas Crockford's base 32`_. + - ``shorturls.baseconv.hexconv`` Hex encoding. + - ``shorturls.baseconv.bin`` Binary encoding, because why not. + +.. _Douglas Crockford's base 32: http://www.crockford.com/wrmg/base32.html -- cgit v1.2.3