Skip to content
Newer
Older
100644 68 lines (39 sloc) 2.8 KB
28426de @timaro Add Omniref link to README
timaro authored Feb 9, 2015
1 # MassiveSitemap [![](http://travis-ci.org/rngtng/massive_sitemap.png)](http://travis-ci.org/rngtng/massive_sitemap) [![massive_sitemap Documentation](https://www.omniref.com/ruby/gems/massive_sitemap.png)](https://www.omniref.com/ruby/gems/massive_sitemap)
a50babe renamed & restructured to massive_sitemap
Tobias Bielohlawek authored Feb 9, 2012
2
29f4394 update README
Tobias Bielohlawek authored Feb 11, 2012
3 Build painfree sitemaps for websites with millions of pages
a50babe renamed & restructured to massive_sitemap
Tobias Bielohlawek authored Feb 9, 2012
4
285999b bundle rc1 release
Tobias Bielohlawek authored Feb 12, 2012
5 MassiveSitemap is a successor project of [BigSitemap](https://github.com/alexrabarts/big_sitemap), a [Sitemap](http://sitemaps.org) generator for websites with millions of pages.
fab1478 updated README
Tobias Bielohlawek authored Mar 13, 2012
6 It implements various generation stategies, e.g. to split large Sitemaps into multiple files, gzip files to minimize bandwidth usage, or incremental updates. Its API is very similar to _BigSitemap_, can be set up with just a few lines of code and is compatible with just about any framework.
7
a50babe renamed & restructured to massive_sitemap
Tobias Bielohlawek authored Feb 9, 2012
8
c4f7221 udpated Readme
Tobias Bielohlawek authored Feb 9, 2012
9 ## Usage
285999b bundle rc1 release
Tobias Bielohlawek authored Feb 12, 2012
10
760b8f8 more README examples
Tobias Bielohlawek authored Jul 15, 2012
11 A simple usecase which fits most of the standard scenarios. This example adds `http://test.com/about` to the sitemap.
fab1478 updated README
Tobias Bielohlawek authored Mar 13, 2012
12
13
9d227e1 better writer init
Tobias Bielohlawek authored Feb 13, 2012
14 ```ruby
90dcf33 added license, cleanup, added docs
Tobias Bielohlawek authored Feb 15, 2012
15 require 'massive_sitemap'
16
760b8f8 more README examples
Tobias Bielohlawek authored Jul 15, 2012
17 index_url = MassiveSitemap.generate(:url => 'test.com') do
18 add "/about"
19 end
20 MassiveSitemap.ping(index_url)
21
22 ```
23
24 ### Using Rails (ActiveRecord)
25
9c76e1c Update README.md
Tobias Bielohlawek authored Jan 12, 2013
26 This example itterates of the `User` resource and adds each with a `change_frequency`, `last_modified` and `priority` to the sitemap. In case there are more than 50.000 users, the sitemap will be auto-split in multiple files.
760b8f8 more README examples
Tobias Bielohlawek authored Jul 15, 2012
27
28 ```ruby
29 require 'massive_sitemap'
30
31 index_url = MassiveSitemap.generate(:url => 'test.com') do
32 User.all do |user|
33 add "/users/#{user.id}", :change_frequency => 'weekly', :last_modified => user.updated_at, :priority => 0.9
34 end
90dcf33 added license, cleanup, added docs
Tobias Bielohlawek authored Feb 15, 2012
35 end
36 MassiveSitemap.ping(index_url)
37
9d227e1 better writer init
Tobias Bielohlawek authored Feb 12, 2012
38 ```
39
fab1478 updated README
Tobias Bielohlawek authored Mar 13, 2012
40 ## Structure
41
42 MassiveSitemap is structured in two major parts: `Builder` and `Writer`. Both offer an abstract interface which is tailored to the specific needs.
43
44 ### Builder
45 `Builder` keeps all the sitemap structure related logic to build the XML data. `Builder::Index` does the similar for the index structure. `Builder::Rotation` is an extension to make sure no more than 50k urls are written per files, according to sitemap specs.
285999b bundle rc1 release
Tobias Bielohlawek authored Feb 12, 2012
46
90dcf33 added license, cleanup, added docs
Tobias Bielohlawek authored Feb 15, 2012
47
fab1478 updated README
Tobias Bielohlawek authored Mar 13, 2012
48 ### Writer
49 The `Writer` takes care of the storage. At top level, that's just a string (`Writer::String`), however `Writer::File` stores to files, `Writer::GzipFile` gzips it as well. `Writer` keeps the state of the files and implements various strategies how to update the files.
90dcf33 added license, cleanup, added docs
Tobias Bielohlawek authored Feb 15, 2012
50
51
fab1478 updated README
Tobias Bielohlawek authored Mar 13, 2012
52 Further extension and customization can easily be done, e.g. a `Writer::S3` [extenstion](https://github.com/rngtng/massive_sitemap-writer-s3) stores the sitemap files to Amazon S3 .
90dcf33 added license, cleanup, added docs
Tobias Bielohlawek authored Feb 15, 2012
53
54 ## Contributing
55
56 We'll check out your contribution if you:
57
58 - Provide a comprehensive suite of tests for your fork.
59 - Have a clear and documented rationale for your changes.
60 - Package these up in a pull request.
61
62 We'll do our best to help you out with any contribution issues you may have.
63
64
65 ## License
66
67 The license is included as LICENSE in this directory.
Something went wrong with that request. Please try again.