From 5653ba06df41fec5d3f99fca12065524bdf3af9f Mon Sep 17 00:00:00 2001 From: Alex Skrypnyk Date: Sun, 17 Nov 2024 12:35:43 +1100 Subject: [PATCH] Moved tables to the bottom of Readme. --- README.md | 142 +++++++++++++++++++++++++++--------------------------- docs.php | 2 +- 2 files changed, 72 insertions(+), 72 deletions(-) diff --git a/README.md b/README.md index 5907c26..f1c5b76 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,77 @@ --- +## Installation and usage + +`Str2Name` is a self-contained class that can be included in any PHP +project directly or via Composer. It does not have any dependencies. + +There are two ways to include `Str2Name` in your project: + +- [Direct download](#direct-download) +- [Composer](#composer) + +### Direct download + +1. Download the file from + the [releases page](https://github.com/AlexSkrypnyk/str2name/releases) + +2. Register the namespace in `composer.json` of your project: + +```composer.json +{ + "autoload": { + "psr-4": { + "AlexSkrypnyk\\Str2Name\\": "path/to/src/Str2Name.php" + } + } +} +``` + +3. Use it in your project: + +```php + `i-am-a__string-with-sp-ce-s-14-and-unicode-l-ve` | | `sentence` | `I am a__string-With sp@ce¥s 14 and 😀 unicode élève`
`I am a string-with sp@ce¥s 14 and 😀 unicode élève` | -## Installation and usage - -`Str2Name` is a self-contained class that can be included in any PHP -project directly or via Composer. It does not have any dependencies. - -There are two ways to include `Str2Name` in your project: - -- [Direct download](#direct-download) -- [Composer](#composer) - -### Direct download - -1. Download the file from - the [releases page](https://github.com/AlexSkrypnyk/str2name/releases) - -2. Register the namespace in `composer.json` of your project: - -```composer.json -{ - "autoload": { - "psr-4": { - "AlexSkrypnyk\\Str2Name\\": "path/to/src/Str2Name.php" - } - } -} -``` - -3. Use it in your project: - -```php -