From 7c972550ffb942fc47f513146894d3bbf49db15d Mon Sep 17 00:00:00 2001 From: Aerex Date: Mon, 5 Jul 2021 15:41:03 -0500 Subject: [PATCH] docs: Cleaned up docs and added information on using cli --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8ea8ec5..ab9828e 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,17 @@ composer require aerex/baikal-storage-plugin ``` ## Configuration -Create the `config.yaml` to your webserver. Make sure the file is *writable* by your webserver (e.g Apache, Nginx). For more details on the configuration details see the wiki page. +You can use the CLI to help you generate a config file or use the example configuration provided in the project. Make sure the file is *writable* by your webserver (e.g Apache, Nginx). + +### Use the CLI +Run the command `./vendor/baikalstorage` and follow the instructions + +### Manual +Copy the `example-config.yaml` file and rename it to `config.yaml`. ## Usage -- Add the plugin to `Core/Frameworks/Baikal/Core/Server.php` +- Add the plugin to the end of the `Server.php` file located under `Core/Frameworks/Baikal/Core/Server.php`. For example + ``` -$this->server->addPlugin(new \Aerex\BaikalStorage\Plugin()) +$this->server->addPlugin(new \Aerex\BaikalStorage\Plugin(