Skip to content

Commit

Permalink
changed tabs to useTabs, updated readme with install example
Browse files Browse the repository at this point in the history
  • Loading branch information
staaky committed Oct 25, 2022
1 parent a724588 commit 24a1008
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 13 deletions.
18 changes: 7 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,13 @@

The Prettier configuration for Bedandbreakfast.eu.

##Usage
## Usage

1. Make sure `@bedandbreakfasteu/prettier-config` is available in your project.
1. Install the package:

```bash
yarn add --dev @bedandbreakfasteu/prettier-config@bedandbreakfasteu/prettier-config#1.0.2
```

2. Add the following to your `package.json`:

Expand All @@ -14,19 +18,11 @@ The Prettier configuration for Bedandbreakfast.eu.
}
```

If you don't want to use `package.json`, use a `.prettierrc.json` that exports a string:

```json
"@bedandbreakfasteu/prettier-config"
```

Or if you need to extend this config use a `.prettierrc.js`:
Or use a `.prettierrc.js` if you need to extend it:

```js
module.exports = {
...require('@bedandbreakfasteu/prettier-config'),
semi: false,
};
```

3. Install the prettier plugin in your IDE and enable `format on save` for auto formatting.
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ module.exports = {
semi: true,
printWidth: 100,
tabWidth: 4,
tabs: false,
useTabs: false,
singleQuote: true,
bracketSpacing: true,
};
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bedandbreakfasteu/prettier-config",
"version": "1.0.1",
"version": "1.0.2",
"description": "Prettier Config",
"author": "Bed & Breakfast Europe",
"license": "MIT",
Expand Down

0 comments on commit 24a1008

Please sign in to comment.