Switch README to Markdown

Author: codingjoe

README.md

@@ -0,0 +1,109 @@
+# Django Dynamic Filenames
+
+Write advanced filename patterns using the [Format String
+Syntax](https://docs.python.org/3/library/string.html#format-string-syntax).
+
+## Getting Started
+
+### Installation
+
+``` sourceCode bash
+pip install django-dynamic-filenames
+```
+
+### Samples
+
+Basic example:
+
+``` sourceCode python
+from django.db import models
+from dynamic_names import FilePattern
+
+upload_to_pattern = FilePattern(
+    filename_pattern='{app_name:.25}/{model_name:.30}/{uuid:base32}{ext}'
+)
+
+class FileModel(models.Model):
+    my_file = models.FileField(upload_to=upload_to_pattern)
+```
+
+Auto slug example:
+
+## Features
+
+### Field names
+
+  - `ext`  
+    File extension including the dot.
+
+  - `name`  
+    Filename excluding the folders.
+
+  - `model_name`  
+    Name of the Django model.
+
+  - `app_label`  
+    App label of the Django model.
+
+  - `instance`  
+    Instance of the model before it has been saved. You may not have a
+    primary key at this point.
+
+  - `uuid`  
+    UUID version 4 that supports multiple type specifiers. The UUID will
+    be the same should you use it twice in the same string, but
+    different on each invocation of the `upload_to` callable.
+    
+    The type specifiers allow you to format the UUID in different ways,
+    e.g. `{uuid:x}` will give you a with a hexadecimal UUID.
+    
+    The supported type specifiers are:
+    
+      - `s`  
+        String representation of a UUID including dashes.
+    
+      - `i`  
+        Integer representation of a UUID. Like to `UUID.int`.
+    
+      - `x`  
+        Hexadecimal (Base16) representation of a UUID. Like to
+        `UUID.hex`.
+    
+      - `X`  
+        Upper case hexadecimal representation of a UUID. Like to
+        `UUID.hex`.
+    
+      - `base32`  
+        Base32 representation of a UUID without padding.
+    
+      - `base64`  
+        Base64 representation of a UUID without padding.
+        
+        **Warning:** Not all file systems support Base64 file names.
+    
+    All type specifiers also support precisions to cut the string, e.g.
+    `{{uuid:.2base32}}` will return the first 2 characters of a Base32
+    encoded UUID.
+
+### Type specifiers
+
+You can also use a special slug type specifier, that slugifies strings.
+
+Example:
+
+``` sourceCode python
+from django.db import models
+from dynamic_names import FilePattern
+
+upload_to_pattern = FilePattern(
+    filename_pattern='{app_name:.25}/{model_name:.30}/{instance.title:.40slug}{ext}'
+)
+
+class FileModel(models.Model):
+    title = models.CharField(max_length=100)
+    my_file = models.FileField(upload_to=upload_to_pattern)
+```
+
+Slug type specifiers also support precisions to cut the string. In the
+example above the slug of the instance title will be cut at 40
+characters.

README.rst

@@ -3,8 +3,8 @@ name = django-dynamic-filenames
 author = Johannes Hoppe
 author-email = info@johanneshoppe.com
 summary = Write advanced filename patterns using the Format String Syntax.
-description-file = README.rst
-description-content-type = text/x-rst; charset=UTF-8
+description-file = README.md
+description-content-type = text/markdown; charset=UTF-8
 home-page = https://github.com/codingjoe/django-dynamic-filenames
 license = MIT
 classifier =