updated README

This commit is contained in:
Josh Nussbaum 2011-10-23 18:30:29 -04:00
parent a2376147f9
commit 568adcdbb6
1 changed files with 14 additions and 8 deletions

View File

@ -1,19 +1,24 @@
Spree Sitemap Generator
=====================
Spree sitemap generator is a sitemap generator based on the sitemap_generator gem http://github.com/kjvarga/sitemap_generator. It adheres to the Sitemap 0.9 protocol specification.
Spree sitemap generator is a sitemap generator based on the sitemap_generator gem [http://github.com/kjvarga/sitemap_generator]. It adheres to the Sitemap 0.9 protocol specification.
Installation
=======
gem install spree-sitemap-generator
1) add the gem to your `Gemfile`:
Example goes here.
`gem 'spree_sitemap_generator'`
Setup
======
2) run bundler:
echo "public/sitemap*" >> .gitignore
`bundle install`
3) add sitemap to your `.gitignore`
`echo "public/sitemap*" >> .gitignore`
4) BOOM you're done!
Features
=====
@ -22,9 +27,10 @@ Features
- Provides basic sitemap of a Spree site
- Allows you to easily add additional sitemaps for pages you add to your site
Special Thanks
=====
- The creators of the rails sitemap gem
- To all who have provided pull requests, its is much appreciated
Copyright (c) 2010 [name of extension creator], released under the New BSD License
Copyright (c) 2011 Joshua Nussbaum, released under the New BSD License