Skip to content
This repository was archived by the owner on Jun 19, 2022. It is now read-only.

Commit 0afeec9

Browse files
author
fd6130
committed
update readme
1 parent 407f359 commit 0afeec9

File tree

1 file changed

+33
-13
lines changed

1 file changed

+33
-13
lines changed

README.md

Lines changed: 33 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,17 @@
22

33
hsl-bundle provide you some nice feature that you might / might not needed:
44

5-
* maker command for DTOs
6-
* maker command for Transformers
7-
* maker command for API CRUD Controller
8-
* pagination
9-
* vich upload event listener
10-
* lexik custom command for generate RSA keys
11-
12-
Please do take note that all the feature from this bundle are using my preference way / format because the purpose of this bundle is used to ease the development of my project.
13-
14-
If you need this bundle features but you have your own prefence way / format for your projects, just fork and modify it!
15-
16-
**The words 'HSL' is a meme from our 17-B students in Discrete Maths course.**
5+
* maker command for DTOs (DTOs are use for POST and PUT request)
6+
* maker command for Transformers (customize your result)
7+
* maker command for API CRUD Controller (boilerplate code for your need)
8+
* pagination (don't need to write your own)
9+
* vich upload event listener (image resize, optimization)
10+
* lexik custom command for generate RSA keys (you don't have to remember the long command RSA)
1711

1812
## Prerequisites
1913

2014
1. PHP 7.2 or above
21-
1. Symfony 5 or above
15+
1. Full set of Symfony 4.4 / 5 (symfony new --full)
2216

2317
**Protips:** Refer to suggest section in `composer.json` to see more useful tools.
2418

@@ -28,6 +22,32 @@ If you need this bundle features but you have your own prefence way / format for
2822
composer require "fd6130/hsl-bundle"
2923
```
3024

25+
## Configuration
26+
27+
Create `config/fd_hsl.yaml` and paste the following content:
28+
29+
```
30+
fd_hsl:
31+
paginator:
32+
default_limit: 30
33+
34+
# This is image upload listener for VichUploaderBundle.
35+
# If you don't want use this listener, just set enable to false.
36+
hsl_image_upload_listener:
37+
enable: true
38+
# Every image you upload will save as the extension you defined.
39+
# Please provide extension name without any punctuation.
40+
# null mean do nothing.
41+
save_as_extension: null
42+
quality: 90
43+
resize:
44+
enable: false
45+
# If image larger then this width (px), it will be resize.
46+
resize_when_width_exceed: 1024
47+
# Resize to width
48+
resize_to_width: 1024
49+
```
50+
3151
## Documentation
3252

3353
Will update this soon.

0 commit comments

Comments
 (0)