From ad446bded0c79577a3d525ad5f0ba236bed4d280 Mon Sep 17 00:00:00 2001 From: Almanov Nikita <131481562+nikkeyl@users.noreply.github.com> Date: Sun, 24 Mar 2024 01:44:22 +0300 Subject: [PATCH] docs(readme): remove `troubleshooting` --- README.md | 27 ++------------------------- 1 file changed, 2 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index c68a7f1..1c09108 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,6 @@ - [Naming Convention](#naming-convention) -- [Troubleshooting](#troubleshooting) - - [Contributing](#contributing) - [License](#license) @@ -87,10 +85,10 @@ const validFontFileName = 'OpenSans-regular'; const invalidFontFileName = 'OpenSans.woff2'; // returns: true -console.log(await validateFontFileName(validFontFileName)); +console.log(await validateFontFileName(validFontFileName, yourPattern)); // returns: 'OpenSans.woff2' doesn't match with '/OpenSans-regular/'. -console.log(await validateFontFileName(invalidFontFileName)); +console.log(await validateFontFileName(invalidFontFileName, yourPattern)); ``` ## Naming Convention @@ -102,27 +100,6 @@ Extensions that are allowed: `otf`, `ttf`, `woff`, `woff2`. > `{FontFamily}-{FontWeight}.{ext}` -## Troubleshooting - -> \[!WARNING] -> Developers Only. - -If you are using **npm**, you may get a `peerDependency` error -that is related to these plugins: - -- `typescript-eslint/eslint-plugin`. -- `typescript-eslint/parser`. - -To fix this you can switch to **pnpm**(recommended) or install version `6.0.0`: - -```shell -typescript-eslint/eslint-plugin@6.0.0 -``` - -```shell -typescript-eslint/parser@6.0.0 -``` - ## Contributing Please read [**CONTRIBUTING**](https://github.com/archoleat/.github/blob/main/CONTRIBUTING.md)