tehfink avatar tehfink committed 0a168cb

readme update

Comments (0)

Files changed (1)

 ALPHA
 
+
 Name: cmsplugin-googlesearch
 Description: for django-cms. provides a plugin interface for google's ajax search api & custom site search, for cms plugins and page apphook attachment
 Download: http://bitbucket.org/tehfink/cmsplugin-googlesearch/
 
+
 Requirements:
-- django-photologue: trunk
 - django-cms-2: 2.0.2
 - django: 1.1.1
 - modified django-pipes: http://github.com/tehfink/django-pipes
 - django.contrib.sites
 
+
 Setup:
+- this release is only compatible with django-cms 2.0.2
 - make sure requirements are installed and properly working
 - add cmsplugin_googlesearch to python path
 - add 'cmsplugin_googlesearch' to settings.INSTALLED_APPS
 - add plugins to pages, AND attach 'Google Search plugin app' to a page (you may have to restart server process for urls to an attached page to work, something with how django-cms caches urls). this is important, as the search plugin redirects to the apphooked page
 - edit settings for the plugin in django administration interface. these settings are cached as well
 
+
 Versioning:
 we're only tracking django-cms releases at this time.
 - branches are named based on django-cms; eg: cms-2.X
 - releases are tagged based on django-cms; eg: cms-2.0.2
 
+
 Optional:
 - define in settings.py:
     CMSPLUGIN_GOOGLESEARCH_CSS_CHOICES - define multiple css classes to apply to plugins
  - http://www.google.com/cse/
  - http://code.google.com/apis/ajaxsearch/web.html
 
+
 Todo:
 - implement paging and result counting
 
+
 Example Projects:
 - are stripped down, slightly modified versions of django-cms' example project for each relevant version
 - require a virtualenv with the requirements above installed
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.