Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tamtamchik authored Feb 23, 2024
1 parent fc0871b commit 5715cbb
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@
[![SensioLabsInsight][ico-insight]][link-insight]

Forenames and surnames are often stored either entirely in UPPERCASE or lowercase. This package allows you to convert
names into the correct case where possible. Although forenames and surnames are typically stored separately if they do
names into the correct case where possible. Although forenames and surnames are typically stored separately, if they
appear in a single string, whitespace-separated, NameCase deals correctly with them.

Currently, NameCase correctly name cases names which include any of the following:
Currently, NameCase correctly name-cases names which include any of the following:

```
Mc, Mac, al, el, ap, bat, ben, bin, binti, binte, da, de, das, dos, delle, della, di, du, del, der, den, ten, ter, la, le, lo, van and von.
```

It correctly deals with names which contain apostrophes and hyphens too.
It correctly deals with names that contain apostrophes and hyphens, too.

> **Warning!** This README.md is for version 3.x.
> If you need PHP 5 compatible version, please use
> If you need a PHP 5 compatible version, please use
> 1.0.x! [README.md](https://github.com/tamtamchik/namecase/blob/1.0.x/README.md#namecase)
## Install
Expand Down Expand Up @@ -84,10 +84,10 @@ str_name_case("VAN DYKE", ['lazy' = false]);

## Options

* `lazy` – Default: `true`. Do not do anything if string is already mixed case and lazy option is `true`.
* `lazy` – Default: `true`. Do not do anything if the string is already mixed case and the lazy option is `true`.
* `irish` – Default: `true`. Correct "Mac" exceptions.
* `spanish` – Default: `false`. Correct `el, la` and spanish conjunctions.
* `roman` – Default: `true`. Correct roman numbers.
* `spanish` – Default: `false`. Correct `el, la` and Spanish conjunctions.
* `roman` – Default: `true`. Correct Roman numbers.
* `hebrew` – Default: `true`. Correct `ben, bat`.
* `postnominal` – Default: `true`. Correct post-nominal e.g. `PhD`.

Expand All @@ -105,7 +105,7 @@ Formatter::nameCase('ČERNÝ MOST');

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Testing & Demo

Expand Down Expand Up @@ -150,6 +150,8 @@ PHP Version:

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

---

[![Buy Me A Coffee][ico-coffee]][link-coffee]

[ico-version]: https://img.shields.io/packagist/v/tamtamchik/namecase.svg?style=flat-square
Expand Down

0 comments on commit 5715cbb

Please sign in to comment.