Skip to content

Commit e4fc247

Browse files
committed
Update readme to fit the new installation process
1 parent b9d7fab commit e4fc247

File tree

1 file changed

+11
-21
lines changed

1 file changed

+11
-21
lines changed

README.md

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ properties are renderable by objects. Let's take the example below:
7777
"filters": {
7878
"active": {
7979
"property": "active",
80-
"val": true
80+
"value": true
8181
}
8282
},
8383
"data": {
@@ -108,10 +108,12 @@ which will be output under the `boilerplate/object/section` on the condition `is
108108
The builder returns only an array. You need to make your own conversation if you need
109109
another format.
110110

111-
Include the service provider:
111+
The Sitemap module will include all necessary service providers and set the route (sitemap.xml) directly. Include the module:
112112

113113
```json
114-
"charcoal/sitemap/service-provider/sitemap": {}
114+
"modules": {
115+
"charcoal/sitemap/sitemap": {}
116+
}
115117
```
116118

117119
Given the settings above:
@@ -133,29 +135,17 @@ to use it with minimal code in every necessary class.
133135
| `relative_urls` | true/false | false | Returns either the absolute URL or the relative URL
134136
| `locale` | string | Current locale | You can choose the locale for the sitemap. (Unless l10n)
135137
| `objects` | object class string | n/a | The objects and their configurations
136-
| `objects` |- |- |-
137-
| `filters` | Array | n/a | Filters for the list
138-
| `orders` | Array | n/a | Orders for the list
139-
| `children` | Array | n/a | Uses the same options as `objects`
140-
| `url` | string | {{url}} | Renderable URL, in case the method is not `url`
141-
| `label` | string | {{title}} | Renderable label, in case it's not `title`
142-
| `data` | Array | n/a | Any order data you want in. This is recursively rendered on the object
138+
| - `filters` | Array | n/a | Filters for the list
139+
| - `orders` | Array | n/a | Orders for the list
140+
| - `children` | Array | n/a | Uses the same options as `objects`
141+
| - `url` | string | {{url}} | Renderable URL, in case the method is not `url`
142+
| - `label` | string | {{title}} | Renderable label, in case it's not `title`
143+
| - `data` | Array | n/a | Any order data you want in. This is recursively rendered on the object
143144

144145
### Sitemap.xml
145146
This contrib provides a route for `sitemap.xml` that dynamically loads the `xml` config and outputs it
146147
as an XML for crawlers to read.
147148

148-
```php
149-
// Config.php
150-
// [...]
151-
152-
// Import routes
153-
$this->addFile(__DIR__ . '/routes.json');
154-
$this->addFile(__DIR__.'/../vendor/locomotivemtl/charcoal-contrib-sitemap/config/routes.json');
155-
156-
// [...]
157-
```
158-
159149
## Development
160150

161151
To install the development environment:

0 commit comments

Comments
 (0)