Skip to content

Commit

Permalink
docs(readme): remove troubleshooting (#9)
Browse files Browse the repository at this point in the history
Co-authored-by: Almanov Nikita <131481562+nikkeyl@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and nikkeyl authored Mar 23, 2024
1 parent c2b05bf commit 80127e5
Showing 1 changed file with 2 additions and 25 deletions.
27 changes: 2 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@

- [Naming Convention](#naming-convention)

- [Troubleshooting](#troubleshooting)

- [Contributing](#contributing)

- [License](#license)
Expand Down Expand Up @@ -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
Expand All @@ -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)
Expand Down

0 comments on commit 80127e5

Please sign in to comment.