Skip to content
Browse files

Updated Docs and install script

  • Loading branch information...
1 parent 13cc5fc commit 9e5c20f3a0c4303028146be1749cc1184ddc8bf9 @maccesch committed Aug 31, 2010
Showing with 49 additions and 12 deletions.
  1. +6 −0 .gitignore
  2. +2 −0 MANIFEST.in
  3. +0 −7 README
  4. +36 −0 README.rst
  5. +5 −5 setup.py
View
6 .gitignore
@@ -0,0 +1,6 @@
+.DS_Store
+DS_STORE
+*.pyc
+*~
+.project
+.pydevproject
View
2 MANIFEST.in
@@ -0,0 +1,2 @@
+recursive-include cmsplugin_contact/locale *.mo
+graft cmsplugin_contact/templates
View
7 README
@@ -1,7 +0,0 @@
-It's a simple contact form application for multi-lang sites.
-This is my first django-cms plugin.
-
-Feel free to use.
-
-Put "cmsplugin_contact.contact" in your INSTALLED_APPS settings.py section.
-Don't forget to syncdb your database.
View
36 README.rst
@@ -0,0 +1,36 @@
+==============================
+Django CMS Contact Form Plugin
+==============================
+
+Contact form plugin for `Django CMS <http://www.django-cms.org/>` with spam protection and i18n.
+
+If you want to use ReCAPTCHA you have to get a Public and Private Key from http://www.google.com/recaptcha. You can get them for free.
+
+The Akismet spam protection method requires an Aksimet API Key which is obtainable from http://akismet.com/ For private persons this is free, too.
+
+For more Information on the spam protection methods see the glamkit-stopspam link below.
+
+Dependencies
+============
+
+Django Apps
+-----------
+
+`glamkit-stopspam <http://github.com/maccesch/glamkit-stopspam>` provides nice spam protection support.
+
+Python Libs
+-----------
+
+If you decide to use the ReCAPTCHA spam protection method glamkit-stopspam needs "recaptcha-client".
+
+If you use Akismet for spam protection "akismet" is needed.
+
+Both libraries can be installed by ``easy_install`` or ``pip``.
+
+Install
+=======
+
+Type ``python setup.py install`` in your terminal.
+
+Put "cmsplugin_contact" in your ``INSTALLED_APPS`` section in settings.py. Don't forget to syncdb your database.
+
View
10 setup.py
@@ -2,11 +2,11 @@
setup(
name='cmsplugin-contact',
- version='0.1',
- description='',
- author='',
- author_email='',
- url='',
+ version='0.2',
+ description='Contact form plugin for Django CMS with spam protection and i18n',
+ author='Maccesch',
+ author_email='maccesch@gmail.com',
+ url='http://github.com/maccesch/cmsplugin_contact',
packages=find_packages(),
classifiers=[
'Development Status :: 4 - Beta',

0 comments on commit 9e5c20f

Please sign in to comment.
Something went wrong with that request. Please try again.