Skip to content

docs: fix grammar and typos in README #204

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.

Sign up for GitHub

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

Open
qisthidev wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fix grammar and typos in README #204

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Display unique avatar for any user based on their (initials) name.
| 5.x | >= 8.0 | 9.x – 11.x | ^2.0 |

## Installation
This package originally built for Laravel, but can also be used in any PHP project.
This package was originally built for Laravel, but can also be used in any PHP project.

[Read more about integration with PHP project here.](#integration-with-other-php-project)

Expand Down Expand Up @@ -113,9 +113,9 @@ Avatar::create('Abdul Somad')->getImageObject();
The method will return an instance of [Intervention image object](https://image.intervention.io/v4), so you can use it for further purposes.

## Non-ASCII Character
By default, this package will try to output any initials letter as it is. If the name supplied contains any non-ASCII character (e.g. ā, Ě, ǽ) then the result will depend on which font used (see config). It the font supports characters supplied, it will successfully displayed, otherwise it will not.
By default, this package will try to output any initials letter as it is. If the name supplied contains any non-ASCII character (e.g. ā, Ě, ǽ) then the result will depend on which font used (see config). If the font supports the characters supplied, they will be displayed successfully, otherwise they will not.

Alternatively, we can convert all non-ascii to their closest ASCII counterparts. If no closest coutnerparts found, those characters are removed. Thanks to [Stringy](https://github.com/danielstjules/Stringy) for providing such useful functions. What we need is just change one line in `config/avatar.php`:
Alternatively, we can convert all non-ascii to their closest ASCII counterparts. If no closest counterparts are found, those characters are removed. Thanks to [Stringy](https://github.com/danielstjules/Stringy) for providing such useful functions. What we need is just change one line in `config/avatar.php`:

```php
'ascii' => true,
Expand Down Expand Up @@ -255,7 +255,7 @@ return [
```

## Overriding config at runtime
We can overriding configuration at runtime by using following functions:
We can override configuration at runtime by using the following functions:

```php
Avatar::create('Soekarno')->setDimension(100);//width = height = 100 pixel
Expand Down
Loading