diff --git a/README b/README index e69de29..6932d1e 100644 --- a/README +++ b/README @@ -0,0 +1,23 @@ +django-queued-storage +================= + +This is a storage backend that allows you specify a local and a remote storage backend. +It will upload locally and then queue up the transfer to your remote backend. If any +request for the file occur before the file gets to the remote backend your local backend +will be used. Once the file has been successfully transferred to the remote backend all +request for the file will use the remote backend. + +This backend requires celery, which is used for the queuing. + +Usage +---------------------------- + +1. Make sure celery is installed and running http://ask.github.com/celery/introduction.html + +2. Make sure you have a cache backend set up. + +4. Add the backend to the storage argument to a FileField + + image = ImageField(storage=QueuedRemoteStorage(local='django.core.files.storage.FileSystemStorage', + remote='backends.s3boto.S3BotoStorage'), upload_to='uploads') +