Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
maximehuran committed Jul 29, 2024
1 parent 0fc1dba commit 0207906
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

Manage your robots.txt from your Sylius admin pannel

![Demo of the settings form to manage robots.txt content](docs/images/demo.jpg)

## Compatibility

| Sylius Version | PHP Version |
Expand All @@ -31,6 +33,41 @@ Then remove your `robots.txt` file from your public directory.
rm public/robots.txt
```

<details><summary>For the installation without flex, follow these additional steps</summary>
<p>

[Setup Settings Installation](https://github.com/monsieurbiz/SyliusSettingsPlugin/?tab=readme-ov-file#installation)

Change your `config/bundles.php` file to add this line for the plugin declaration:
```php
<?php

return [
//..
MonsieurBiz\SyliusRobotsTxtPlugin\MonsieurBizSyliusRobotsTxtPlugin::class => ['all' => true],
];
```

Then create the config file in `config/packages/monsieurbiz_sylius_robots_txt_plugin.yaml` :

```yaml
imports:
resource: '@MonsieurBizSyliusRobotsTxtPlugin/Resources/config/config.yaml'
```
Finally import the routes in `config/routes/monsieurbiz_sylius_robots_txt_plugin.yaml` :

```yaml
monsieurbiz_robots_txt_render:
path: /robots.txt
methods: [ GET ]
defaults:
_controller: MonsieurBiz\SyliusRobotsTxtPlugin\Controller\RenderController
```

</p>
</details>

## Contributing

You can open an issue or a Pull Request if you want! 😘
Expand Down
Binary file added docs/images/demo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0207906

Please sign in to comment.