Fixing package files.

diff --git a/MANIFEST.in b/MANIFEST.in
index 5cd6f0ca9615d714e95147d960dba1983fe5073b..ef2435a82b8683c8f7f9f8cd85c77ff6308e3a9a 100644 (file)
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,2 +1,2 @@
-include README.rst
+include README
 recursive-include notes/templatetags * 

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..6ba7bf2
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+django-notes
+=============
+
+A simple application to allow you to attach notes to models.
+
+Installation
+-------------
+
+Notes uses generic relations to handle attaching themselves to models. So installation is basically just like adding a generic relation item to your model.
+
+1. Add 'notes' to your INSTALLED_APPS variable
+2. Import the Note model:
+
+        from notes.models import Note
+
+3. Add the note inline to your model's admin def in your admin.py file:
+
+        from notes.admin import NoteInline
+
+        class YourModelAdmin(admin.ModelAdmin):
+            inlines = [ NoteInline, ]
+        
+4. To enable easy management you can add a hook to your model:
+
+        notes=generic.GenericRelation(Note)
+
+Usage
+------
+Follow the steps above (including 4) and you should have access to all the notes at instance_of_yourmodel.notes_set.all():
+
+    >>> object = YourModel.objects.get(pk=1)
+    >>> notes_for_object = object.notes_set.all()
+
+Simple.
\ No newline at end of file

diff --git a/README.md b/README.md
deleted file mode 100644 (file)
index 6ba7bf2..0000000
--- a/README.md
+++ /dev/null
@@ -1,34 +0,0 @@
-django-notes
-=============
-
-A simple application to allow you to attach notes to models.
-
-Installation
--------------
-
-Notes uses generic relations to handle attaching themselves to models. So installation is basically just like adding a generic relation item to your model.
-
-1. Add 'notes' to your INSTALLED_APPS variable
-2. Import the Note model:
-
-        from notes.models import Note
-
-3. Add the note inline to your model's admin def in your admin.py file:
-
-        from notes.admin import NoteInline
-
-        class YourModelAdmin(admin.ModelAdmin):
-            inlines = [ NoteInline, ]
-        
-4. To enable easy management you can add a hook to your model:
-
-        notes=generic.GenericRelation(Note)
-
-Usage
-------
-Follow the steps above (including 4) and you should have access to all the notes at instance_of_yourmodel.notes_set.all():
-
-    >>> object = YourModel.objects.get(pk=1)
-    >>> notes_for_object = object.notes_set.all()
-
-Simple.
\ No newline at end of file

diff --git a/setup.py b/setup.py
index a13a7c58c01d445bb491b34fee6793e2469fd41c..1ed0afc9ec6092357d005dad92c37f4c0aa1a5c1 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -8,7 +8,7 @@ setup(
     install_requires = [],
 
     description='A reusable applicaton to add arbitrary notes to a model.',
-    long_description=open('README.md').read(),
+    long_description=open('README').read(),
 
     author='Colin Powell',
     author_email='colin@onecardinal.com',