README.md in middleman-search_engine_sitemap-1.0.0 vs README.md in middleman-search_engine_sitemap-1.0.1
- old
+ new
@@ -1,19 +1,20 @@
# Middleman Search Engine Sitemap
[](https://travis-ci.org/Aupajo/middleman-search_engine_sitemap)
[](https://codeclimate.com/github/Aupajo/middleman-search_engine_sitemap)
+[](https://gemnasium.com/Aupajo/middleman-search_engine_sitemap)
[Sitemaps](http://www.sitemaps.org/) are an open standard to tell search engines (such as Google) about each page on your site, how often they're updated, and how important each page is, relative to other pages on your site.
This project aims to simplify including the sitemap XML file along with your Middleman site, so that you can better instruct search engines on how to index your pages.
For more information on the standard itself, please visit http://www.sitemaps.org/.
## Installation
-Add this line to your Middleman site's Gemfile:
+Add this line to your Middleman site's `Gemfile`:
```ruby
gem 'middleman-search_engine_sitemap'
```
@@ -25,29 +26,35 @@
$ gem install middleman-search_engine_sitemap
## Usage
-Inside your `config.rb`:
+Place the following inside your `config.rb`:
```ruby
set :url_root, 'http://example.com'
activate :search_engine_sitemap
```
+The sitemap will become available at [http://localhost:4567/sitemap.xml](http://localhost:4567/sitemap.xml).
+
+### Settings
+
Pages have a priority of 0.5 and a change frequency of `monthly` by default.
You can change these values by passing in options to the `activate` directive:
```ruby
activate :search_engine_sitemap, default_priority: 0.5,
default_change_frequency: "monthly"
```
-You can override the priority or change frequency on particular pages by using frontmatter:
+### Specifying priority and change frequency for a page
+You can override the priority or change frequency for a particular page by using frontmatter:
+
```erb
---
title: Blog
priority: 1.0
change_frequency: daily
@@ -76,10 +83,10 @@
The default value is `monthly`.
## Contributing
-1. Fork it ( http://github.com/<my-github-username>/middleman-search_engine_sitemap/fork )
+1. Fork it ( http://github.com/Aupajo/middleman-search_engine_sitemap/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request