From 2c4a1dd786ffe95453013c7d6364aee467c838a8 Mon Sep 17 00:00:00 2001 From: Isaac Bythewood Date: Thu, 26 Apr 2012 18:49:31 +0000 Subject: [PATCH] README updates. --- README.md | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ad8056b..024fa70 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,28 @@ # Pinry -A Wookmark/Pintrest clone created for self hosting. With all the silly uproar -over if it's legal or not to "pin" images I decided to just create a -self-hosted version that doesn't have the issue of some of your images randomly -showing up missing. +Pinry is a self-hostable [Pintrest][0] "clone" that has a strong resemblance to +[Wookmark][1]. (Because I use their jQuery library and like their design.) -## To run Pinry... +## Why? + +Because I don't like sharing. I would use these services to store a lot of +images and data that isn't necessarily personal but that I don't actually want +to share or deal with the possibility of having it taken down by a DMCA notice. +My use of Pintrest/Wookmark boils down to having personal board for things I +want to remember or keep for inspiration. + +## Plans + +Some features that I want to impelement, if you know how to implement them then +please do them for me! I'm very pull-request friendly and will not yell at you +for bad code, I'll simply work with you to improve it. + + + Add non-image URL support, take "screenshot" of page as a thumbnail. + + Create a bookmarklet for quick saving. + + Manual and automatic tagging via description, image alt tags and whatever else I can scrape. + + Statistics page with graphs for image views, what times of day have the most posts, etc. + +## Getting Started Have virtualenv and pip installed. You may also need to have the build dependencies for PIL installed. (If you are on Ubuntu you can do this by typing @@ -19,5 +36,10 @@ dependencies for PIL installed. (If you are on Ubuntu you can do this by typing $ bin/python manage.py migrate $ bin/python manage.py runserver -Following this will get you a test server up and running, google around for -more information on running Django on a production server. +Following this will get you a development server up and running. If you want a +production server [Google around][2] for more information on running Django in a +production environment and create a "pinry/settings/production.py" file. + +[0]: http://pinterest.com/ +[1]: http://www.wookmark.com/ +[2]: https://www.google.com/search?q=deploy+django+production