Skip to content

Commit 9ee565c

Browse files
committed
Add emoji to README
1 parent a2e6975 commit 9ee565c

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,30 +18,30 @@
1818
- Optionally [translate each segment](#translate-routes) in your URI's.
1919
- **Let you work with routes without thinking too much about locales.**
2020

21-
## Requirements
21+
## Requirements
2222

2323
- PHP >= 7.1
2424
- Laravel >= 5.6
2525

26-
## Install
26+
## 📦 Install
2727

2828
```php
2929
composer require codezero/laravel-localized-routes
3030
```
3131

3232
> Laravel will automatically register the ServiceProvider.
3333
34-
## Configure
34+
## ⚙️ Configure
3535

36-
#### Publish Configuration File
36+
#### ☑️ Publish Configuration File
3737

3838
```php
3939
php artisan vendor:publish --provider="CodeZero\LocalizedRoutes\LocalizedRoutesServiceProvider" --tag="config"
4040
```
4141

4242
You will now find a `localized-routes.php` file in the `config` folder.
4343

44-
#### Supported Locales
44+
#### ☑️ Supported Locales
4545

4646
##### Using Slugs
4747

@@ -65,7 +65,7 @@ Alternatively, you can use a different domain or subdomain for each locale by ad
6565
],
6666
```
6767

68-
#### Omit Slug for Main Locale
68+
#### ☑️ Omit Slug for Main Locale
6969

7070
Specify your main locale if you want to omit its slug from the URL:
7171

@@ -81,7 +81,7 @@ Setting this option to `'en'` will result, for example, in URL's like this:
8181

8282
> This option has no effect if you use domains instead of slugs.
8383
84-
## Register Routes
84+
## 🚗 Register Routes
8585

8686
Example:
8787

@@ -124,9 +124,9 @@ If you set `omit_url_prefix_for_locale` to `'en'` in the configuration file, the
124124
| /admin/reports | en.admin.reports.index |
125125
| /nl/admin/reports | nl.admin.reports.index |
126126

127-
**Beware that you don't register the same URL twice when omitting the locale.** You can't have a localized `/about` route and also register a non-localized `/about` route in this case. The same idea applies to the `/` (root) route! Also note that the route names still have the locale prefix.
127+
**⚠️ Beware that you don't register the same URL twice when omitting the locale.** You can't have a localized `/about` route and also register a non-localized `/about` route in this case. The same idea applies to the `/` (root) route! Also note that the route names still have the locale prefix.
128128

129-
### Generate Route URL's
129+
### 🚕 Generate Route URL's
130130

131131
You can get the URL of your named routes as usual, using the `route()` helper.
132132

@@ -163,7 +163,7 @@ $url = route('en.about', [], true, 'nl'); // /nl/about
163163

164164
> **Note:** in a most practical scenario you would register a route either localized **or** non-localized, but not both. If you do, you will always need to specify a locale to get the URL, because non-localized routes always have priority when using the `route()` function.
165165
166-
### Redirect to Routes
166+
### 🚌 Redirect to Routes
167167

168168
Laravel's `Redirector` uses the same `UrlGenerator` as the `route()` function behind the scenes. Because we are overriding this class, you can easily redirect to your routes.
169169

@@ -178,7 +178,7 @@ You can't redirect to URL's in a specific locale this way, but if you need to, y
178178
return redirect(route('about', [], true, 'nl')); // redirects to /nl/about
179179
```
180180

181-
### Translate Routes
181+
### 🌎 Translate Routes
182182

183183
If you want to translate the segments of your URI's, create a `routes.php` language file for each locale you [configured](#configure-supported-locales):
184184

@@ -219,7 +219,7 @@ The above will generate:
219219

220220
> If a translation is not found, the original segment is used.
221221
222-
## Route Placeholders
222+
## 🚏 Route Placeholders
223223

224224
Placeholders are not translated via language files. These are values you would provide via the `route()` function. The `Lang::uri()` macro will skip any placeholder segment.
225225

@@ -269,28 +269,28 @@ $url = route('posts.show', $post); // /en/posts/en-slug
269269
$url = route('posts.show', $post, true, 'nl'); // /nl/posts/nl-slug
270270
```
271271

272-
## Cache Routes
272+
## 🗃 Cache Routes
273273

274274
In production you can safely cache your routes per usual.
275275

276276
```php
277277
php artisan route:cache
278278
```
279279

280-
## Testing
280+
## 🚧 Testing
281281

282282
```
283283
composer test
284284
```
285285

286-
## Security
286+
## 🔐 Security
287287

288288
If you discover any security related issues, please [e-mail me](mailto:[email protected]) instead of using the issue tracker.
289289

290-
## Changelog
290+
## 📖 Changelog
291291

292292
See a list of important changes in the [changelog](CHANGELOG.md).
293293

294-
## License
294+
## 📜 License
295295

296296
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

0 commit comments

Comments
 (0)