Merge pull request Shelf-nu#865 from Shelf-nu/DonKoko-patch-5

Update README.md
thundersquared · Mar 20, 2024 · bf36023 · bf36023
2 parents bbeea49 + c3f8083
commit bf36023
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -6,8 +6,8 @@ Here you can find the documentation for shelf.
 
 - [Getting Started](./get-started.md) - Instructions for how to get started
   with Shelf.
-- [Response and Error handling](../handling-errors.md) - Guide on how to handle responses and errors in actions/loaders and services
-- [Shelf Config file](../shelf-config.md) - Shelf configuration file
+- [Response and Error handling](./handling-errors.md) - Guide on how to handle responses and errors in actions/loaders and services
+- [Shelf Config file](./shelf-config.md) - Shelf configuration file
 - [Asset Search](./asset-search.md) - Asset search via Prisma Full text search
 - [Docker](./docker.md) - Run shelf via docker
 - [Contributing](../CONTRIBUTING.md) - Contributing to Shelf.
diff --git a/docs/shelf.config.ts.md b/docs/shelf.config.ts.md
@@ -8,14 +8,15 @@ import { ENABLE_PREMIUM_FEATURES } from "~/utils";
 import { Config } from "./types";
 
 export const config: Config = {
-  sendOnboardingEmail: true,
+  sendOnboardingEmail: SEND_ONBOARDING_EMAIL || false,
   enablePremiumFeatures: ENABLE_PREMIUM_FEATURES || false,
 };
 ```
 
 ## sendOnboardingEmail
 
 This flag allows you to choose whether the onboarding email will be sent to new users. Email is being sent within the action of `routes/_welcome+/onboarding.tsx`
+Default value is false. If you want to override it you can use the env variable `SEND_ONBOARDING_EMAIL`
 
 ```ts
 //remix.config.ts