From d9a9414fb08bad0d7f2040f00152be96b5a12a28 Mon Sep 17 00:00:00 2001 From: Hasan Turken Date: Mon, 31 Jul 2023 09:25:58 +0300 Subject: [PATCH] Update README for improved generation steps Signed-off-by: Hasan Turken --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3e0c8d1..f06a7af 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,16 @@ with the following features that are meant to be refactored: 1. Use this repository as a template to create a new one. 1. Run `make submodules` to initialize the "build" Make submodule we use for CI/CD. -1. Rename the provider by running the follwing command: -``` - make provider.prepare provider={PascalProviderName} +1. Rename the provider by running the following command: +```shell + export provider_name=MyProvider # Camel case, e.g. GitHub + make provider.prepare provider=${provider_name} ``` 4. Add your new type by running the following command: -``` -make provider.addtype provider={PascalProviderName} group={group} kind={type} +```shell + export group=sample # lower case e.g. core, cache, database, storage, etc. + export type=MyType # Camel casee.g. Bucket, Database, CacheCluster, etc. + make provider.addtype provider=${provider_name} group=${group} kind=${type} ``` 5. Replace the *sample* group with your new group in apis/{provider}.go 5. Replace the *mytype* type with your new type in internal/controller/{provider}.go