Permalink
Browse files

README and LICENSE added

  • Loading branch information...
1 parent 592a90b commit 037cdcf444cc99965ad6517ada21a37cf28cc3d1 @dryan committed May 25, 2012
Showing with 44 additions and 1 deletion.
  1. +26 −0 LICENSE
  2. +18 −1 README.md
View
26 LICENSE
@@ -0,0 +1,26 @@
+Copyright (c) 2012, Daniel Ryan
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice,
+ this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+ * Neither the name of "dryan" nor Daniel Ryan nor the names of its contributors may be used
+ to endorse or promote products derived from this software without
+ specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
View
@@ -1,4 +1,21 @@
django-admin-twitter-bootstrap
==============================
-Django admin templates that are compatible with Twitter Bootstrap version 2.
+Django admin templates that are compatible with Twitter Bootstrap version 2.
+
+## Usage
+
+1. Clone the repository into your Django project.
+2. Add the path to 'admin_bootstrap/templates' to your `TEMPLATE_DIRS` setting.
+3. Add 'admin_bootstrap' to your `INSTALLED_APPS` setting.
+4. Run `python manage.py collectstatic`.
+
+Alternatively to #2, you can symlink the 'admin', 'admin_doc' and 'registration' folders in 'admin_bootstrap/templates' to your templates folder.
+
+## TODO
+
+* Test more Django form field types and admin options.
+
+## LICENSE
+
+Offered under a [BSD 3 Clause License](https://github.com/dryan/django-admin-twitter-bootstrap/blob/master/LICENSE).

0 comments on commit 037cdcf

Please sign in to comment.