Skip to content

Commit c566226

Browse files
committed
README updates
1 parent 5d6f8b4 commit c566226

File tree

1 file changed

+9
-14
lines changed

1 file changed

+9
-14
lines changed

README.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,7 @@ entries (the limit), the sitemap becomes a "map of maps" (i.e. nested sitemaps).
1111

1212
**Documentation:** [http://tackk.github.io/cartographer/](http://tackk.github.io/cartographer/)
1313

14-
## Usage
15-
16-
**Note: This is still a work in progress, so this may change, and it most certainly is not yet stable for
17-
production.**
18-
19-
### Basic Sitemap
14+
## Basic Sitemap
2015

2116
If you have a sitemap that is under 50,000 items, you can just use the Sitemap class, and avoid the Sitemap
2217
Generator.
@@ -37,7 +32,7 @@ header ('Content-Type:text/xml');
3732
echo $sitemap->toString();
3833
```
3934

40-
#### Output
35+
### Output
4136

4237
``` xml
4338
<?xml version="1.0" encoding="UTF-8"?>
@@ -55,7 +50,7 @@ echo $sitemap->toString();
5550
</urlset>
5651
```
5752

58-
### Basic Sitemap Index
53+
## Basic Sitemap Index
5954

6055
If you want to build a Sitemap Index, seperate from the Sitemap Generator, you can!
6156

@@ -72,7 +67,7 @@ header ('Content-Type:text/xml');
7267
echo $sitemapIndex->toString();
7368
```
7469

75-
#### Output
70+
### Output
7671

7772
``` xml
7873
<?xml version="1.0" encoding="UTF-8"?>
@@ -88,14 +83,14 @@ echo $sitemapIndex->toString();
8883
</sitemapindex>
8984
```
9085

91-
### Sitemap Factory
86+
## Sitemap Factory
9287

9388
The Sitemap Factory create Sitemaps and Sitemap Indexes and writes them to the Filesystem.
9489
Is is can be used to generate full Sitemaps with more than **50,000** URLs.
9590

9691
If more than one sitemap is generated, it will create a Sitemap Index automatically.
9792

98-
#### Instantiating
93+
### Instantiating
9994

10095
The factory uses [Flysystem](http://flysystem.thephpleague.com/) to write the sitemaps. This
10196
means you can write the sitemaps to Local Disk, S3, Dropbox, wherever you want.
@@ -112,7 +107,7 @@ $sitemapFactory = new Tackk\Cartographer\SitemapFactory($filesystem);
112107

113108
```
114109

115-
#### Base URL
110+
### Base URL
116111

117112
The Base URL is used when generating the Sitemap Indexes, and for the returned entry point URL.
118113

@@ -124,7 +119,7 @@ $sitemapFactory->setBaseUrl('http://foo.com/sitemaps/');
124119

125120
You can get the current base URL using `getBaseUrl()`.
126121

127-
#### Creating a Sitemap
122+
### Creating a Sitemap
128123

129124
To create a sitemap you use the `createSitemap` method. This method requires an `Iterator` as
130125
its only parameter.
@@ -147,7 +142,7 @@ $mainSitemap = $sitemapFactory->createSitemap($urls);
147142

148143
```
149144

150-
#### Return Value
145+
### Return Value
151146

152147
The two creation methods (`createSitemap` and `createSitemapIndex`) will return the URL
153148
of the root sitemap file. If there is only 1 sitemap created, it will return just that URL.

0 commit comments

Comments
 (0)