From 1287fd7fcde4ac41e7833f8fba330e6db2974e0f Mon Sep 17 00:00:00 2001 From: Alexandre Batistella Bellas Date: Mon, 14 Aug 2023 12:10:35 -0300 Subject: [PATCH] chore: update readme --- readme.md | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/readme.md b/readme.md index 71cf4cb..8519ec8 100644 --- a/readme.md +++ b/readme.md @@ -52,7 +52,7 @@ To use it, use the defined methods below directly in your Dusk tests. ``` /** @test */ -public function your_dusk_test() +public function test_should_use_dusk_for_something () { // Get a config variable // Here, $appName will be "Laravel" on a fresh install @@ -61,30 +61,28 @@ public function your_dusk_test() // Change a config variable $this->setConfig('app.name', 'Laravel is fantastic'); - // Here, $appName will be Laravel is fantastic + // Here, $appName will be "Laravel is fantastic" $appName = $this->getConfig('app.name'); // Your tests with assertions + // ... // You can reset all config variables set before. - // This is not mandatory: you can keep the variables set for the next test if you want. + // This is not mandatory: you can keep the variables set for the next test + // if you want (even though it is not a good practice). $this->resetConfig(); } ``` -## Change location of the config temporary file - -Type the following commands: +## Publish configuration file ``` php artisan vendor:publish --provider="AleBatistella\DuskApiConf\DuskApiConfServiceProvider" ``` -Modify the Storage disk and the name of the temporary file. - -## Contribute - -Feel free to open issues or submit pull requests. +With this command, you'll create a new `duskapiconf.php` in the `config` folder. +Then, you can modify the storage disk and the name of the temporary file, +including configuration about the used environment. ## License