Skip to content

Commit 90f6ece

Browse files
authored
Update README.md
1 parent 1e3f645 commit 90f6ece

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,32 @@
1-
# Translation plugin
1+
# Translate Plugin
22

3-
Enables multi-lingual sites.
3+
Adds multi-lingual / localization capabilities to the frontends of Winter CMS websites.
44

5-
## Getting started
5+
Supports:
6+
- Frontend Language Picker component
7+
- Static string/message localizations
8+
- CMS Content files localizations
9+
- Mail template localizations
10+
- Model attribute localizations
11+
- Theme Data & Settings localizations
12+
- URL & URL attribute localizations
13+
- Simple UX in backend for providing localized values
14+
- Easy integration with external plugins
615

7-
Use composer to install the plugin:
16+
## Installation
17+
18+
This plugin is available for installation via [Composer](http://getcomposer.org/).
819

920
```bash
1021
composer require winter/wn-translate-plugin
1122
```
1223

13-
Then, run the migrations to ensure the plugin is enabled:
24+
After installing the plugin you will need to run the migrations and (if you are using a [public folder](https://wintercms.com/docs/develop/docs/setup/configuration#using-a-public-folder)) [republish your public directory](https://wintercms.com/docs/develop/docs/console/setup-maintenance#mirror-public-files).
1425

1526
```bash
16-
php artisan winter:up
27+
php artisan migrate
1728
```
1829

19-
If you are using a [public folder](https://wintercms.com/docs/setup/configuration#public-folder) then you will also need to regenerate it with `php artisan winter:mirror public --relative`
2030
## Selecting a language
2131

2232
Different languages can be set up in the back-end area, with a single default language selected. This activates the use of the language on the front-end and in the back-end UI.

0 commit comments

Comments
 (0)