From 99995cbb8970515e315aa55160653b24a16921bd Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Sun, 29 Jan 2023 05:05:18 +0000 Subject: [PATCH] readme updates --- .codeclimate.yml | 2 +- README.md | 5 ++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/.codeclimate.yml b/.codeclimate.yml index b85c6b9..7b6d9a8 100644 --- a/.codeclimate.yml +++ b/.codeclimate.yml @@ -11,7 +11,7 @@ checks: threshold: 8 method-lines: config: - threshold: 40 + threshold: 50 exclude_patterns: - 'config/' diff --git a/README.md b/README.md index ec99c40..16f9ee8 100644 --- a/README.md +++ b/README.md @@ -86,11 +86,10 @@ If you want to know how, have a look at the respective components: ### 💅 Theme switcher -Includes a theme switcher which allows user to toggle between a light and a dark theme. Switching between them also happens automatically based on user's system preferences. +Includes a theme switcher which allows user to toggle between a light and a dark theme. Switching between them also happens automatically based on user's system preferences. Uses [next-themes](https://github.com/pacocoursey/next-themes) under the hood. -If you want to know how, have a look at the respective components: +If you want to know how, have a look at the respective component: -- [`src/hooks/useDarkMode.ts`](src/hooks/useDarkMode.ts) - [`src/components/ThemeSwitch/index.tsx`](src/components/ThemeSwitch/index.tsx) ### 🏆 SEO component