Updated readme + changelog

Lukasss93 · Aug 8, 2020 · b9a48e4 · b9a48e4
1 parent a34a277
commit b9a48e4
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v1.3 - 2020-08-08
+### Added
+- Added `larex:export` command (it's an alias of `larex` command)
+
+### Changed
+- Deprecated `larex` command (it will be removed in the next release)
+
+### Fixed
+- Sentences with line break aren't escaped.
+
 ## v1.2 - 2020-07-18
 ### Added
 - Added `larex:import` command

diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 [![License](https://poser.pugx.org/lukasss93/laravel-larex/license)](https://packagist.org/packages/lukasss93/laravel-larex)
 ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Lukasss93/laravel-larex/run-tests)
 [![Coveralls github](https://img.shields.io/coveralls/github/Lukasss93/laravel-larex)](https://coveralls.io/github/Lukasss93/laravel-larex)
-[![Chat](https://img.shields.io/badge/chat-on%20telegram-blue)](https://t.me/Lukasss93)
+[![Chat](https://img.shields.io/badge/chat%20on-telegram-blue)](https://t.me/Lukasss93)
 
 Translate your Laravel application from a single CSV file!
 
@@ -39,15 +39,15 @@ This step *can be skipped* if package auto-discovery is enabled.
 
 2. Open the *project-root/resources/lang/localization.csv* file and edit it as you see fit.
 
-3. Finally, you can use `php artisan larex` to translate your entries from the csv file to the laravel php files.
+3. Finally, you can use `php artisan larex:export` to translate your entries from the csv file to the laravel php files.
 
 ### Tips
 * You can import existing laravel php files with `php artisan larex:import`.
 * You can use `php artisan larex:init --base` to init the CSV file with default Laravel entries.
 * The **key** column inside the CSV file supports the **dot notation** for nested arrays.
 * You can watch your CSV file with `php artisan larex --watch`
 * You can use `php artisan larex:sort` to sort the CSV file by group and key.
-* Be careful when using the `php artisan larex` command! It will overwrite all files named with the group names inside the CSV.
+* Be careful when using the `php artisan larex:export` command! It will overwrite all files named with the group names inside the CSV.
 * Be careful when using the **dot notation**! Only the **last** entry will override the value.
 
 ### Example
@@ -57,9 +57,10 @@ This step *can be skipped* if package auto-discovery is enabled.
    | group | key | en | it |
    |---|---|---|---|
    | app | hello | Hello | Ciao |
-   | app | developers | Developers | Sviluppatori |
+   | app | list.developers | Developers | Sviluppatori |
+   | app | list.teachers | Teachers | Insegnanti |
 
-3. Run `php artisan larex` command
+3. Run `php artisan larex:export` command
 4. You'll get the following files:
    ```php
    //project-root/resources/lang/en/app.php
@@ -68,7 +69,10 @@ This step *can be skipped* if package auto-discovery is enabled.
 
    return [
        'hello' => 'Hello',
-       'developers' => 'Developers',
+       'list' => [
+           'developers' => 'Developers',
+           'teachers' => 'Teachers',
+       ]
    ];
 
    //project-root/resources/lang/it/app.php
@@ -77,7 +81,10 @@ This step *can be skipped* if package auto-discovery is enabled.
 
    return [
        'hello' => 'Ciao',
-       'developers' => 'Sviluppatori',
+       'list' => [
+           'developers' => 'Sviluppatori',
+           'teachers' => 'Insegnanti',
+       ]
    ];
    ```