Skip to content

Docs: update readme.md #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Laravel Image Handler

Handle image in multiple different size with optimization.
Optimize and store images in multiple sizes easily.


### Installation steps
Expand All @@ -12,25 +12,25 @@ php artisan vendor:publish --provider="codepane\LaravelImageHandler\ImageHandler

### Configuration

* After installation done once you can see imagehandler.php under the config dirctory.
* You can udpate dimensions, format and quality as per your need from configuration file.
* You can also add new dimension.
* After installation is done once you can see imagehandler.php under the config directory.
* You can update dimensions, format, and quality as per your need from a configuration file.
* You can also add a new dimension.



## Usage
Lets deep dive into this package for how to use it
Let's deep dive into this package for how to use it

### Store Image
```
use ImageHandler;

public function store()
{
// its take default file name as it is
// its takes the default file name as it is
ImageHandler::store($request->file);

// in 2nd argument you can pass your custom file name with or without path
// in 2nd argument you can pass your custom file name with or without the path
ImageHandler::store($request->file, 'file_name_with_or_without_path');
}
```
Expand All @@ -41,10 +41,10 @@ use ImageHandler;

public function get()
{
// this will return original image
// this will return the original image
ImageHandler::get('original_file_name');

// pass dimension as second argument for get specific dimension of file
// pass dimension as the second argument to get a specific dimension of the file
ImageHandler::get('original_file_name', 'sm');
}
```
Expand All @@ -64,5 +64,5 @@ public function delete()

Contributions are always welcome!

- Make pull request if you have to contribute for this lovely library!
- Make a pull request if you have to contribute to this lovely library!
- We will review and pull your request.
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "codepane/laravel-image-handler",
"description": "Handle image in multiple different size with optimization.",
"description": "Optimize and store images in multiple sizes easily.",
"type": "library",
"require": {
"intervention/image": "^2.7"
Expand Down