From 5b72035507ee9d86d4e50c42350e83eab1040d86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20L=C3=BCck?= Date: Mon, 5 Aug 2024 23:26:02 +0200 Subject: [PATCH] Update examples and add .gitattributes to exclude dev files from exports --- .gitattributes | 7 +++++++ README.md | 8 ++++++-- {example => examples}/client.php | 4 +--- {example => examples}/perf.php | 5 +---- 4 files changed, 15 insertions(+), 9 deletions(-) create mode 100644 .gitattributes rename {example => examples}/client.php (91%) rename {example => examples}/perf.php (89%) diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..da20d18 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,7 @@ +/.gitattributes export-ignore +/.github/workflows/ export-ignore +/.gitignore export-ignore +/examples/ export-ignore +/phpunit.xml.dist export-ignore +/phpunit.xml.legacy export-ignore +/tests/ export-ignore diff --git a/README.md b/README.md index 1c4efe7..2c7ae13 100644 --- a/README.md +++ b/README.md @@ -43,9 +43,11 @@ Let's take these projects to the next level together! 🚀 ## Quickstart example ```php -use Clue\Redis\Protocol; +createResponseParser(); $serializer = $factory->createSerializer(); @@ -63,6 +65,8 @@ var_dump($reply1->getValueNative()); // string(2) "OK" var_dump($reply2->getValueNative()); // string(5) "value" ``` +See also the [examples](examples/). + ## Usage ### Factory diff --git a/example/client.php b/examples/client.php similarity index 91% rename from example/client.php rename to examples/client.php index d1b4428..61b5d8e 100644 --- a/example/client.php +++ b/examples/client.php @@ -2,9 +2,7 @@ require __DIR__ . '/../vendor/autoload.php'; -use Clue\Redis\Protocol; - -$factory = new Protocol\Factory(); +$factory = new Clue\Redis\Protocol\Factory(); $parser = $factory->createResponseParser(); $serializer = $factory->createSerializer(); diff --git a/example/perf.php b/examples/perf.php similarity index 89% rename from example/perf.php rename to examples/perf.php index c5ce6a7..8c17eae 100644 --- a/example/perf.php +++ b/examples/perf.php @@ -1,11 +1,8 @@ createResponseParser(); $serializer = $factory->createSerializer();