Skip to content

Commit 22041f3

Browse files
committed
docs(readme): update naming again
1 parent 875e614 commit 22041f3

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<h1>hvr-scripts 🛠📦</h1>
2+
<h1>@hover/javascript 🛠📦</h1>
33

44
<p>CLI toolbox for common scripts for <del>my</del> <strong>our</strong> projects</p>
55
</div>
@@ -39,25 +39,25 @@ This module is distributed via [npm][npm] which is bundled with [node][node] and
3939
should be installed as one of your project's `devDependencies`:
4040

4141
```
42-
yarn add -D hvr-scripts
42+
yarn add -D @hover/javascript
4343
```
4444

4545
## Usage
4646

47-
This is a CLI and exposes a bin called `hvr-scripts`. You'll find all available scripts in `src/scripts`.
47+
This is a CLI and exposes a bin called `hover-scripts`. You'll find all available scripts in `src/scripts`.
4848

4949
This project actually dogfoods itself. If you look in the `package.json`, you'll
5050
find scripts with `node src {scriptName}`. This serves as an example of some
51-
of the things you can do with `hvr-scripts`.
51+
of the things you can do with `hover-scripts`.
5252

5353
### Overriding Config
5454

55-
Unlike `react-scripts`, `hvr-scripts` allows you to specify your own
55+
Unlike `react-scripts`, `hover-scripts` allows you to specify your own
5656
configuration for things and have that plug directly into the way things work
57-
with `hvr-scripts`. There are various ways that it works, but basically if you
57+
with `hover-scripts`. There are various ways that it works, but basically if you
5858
want to have your own config for something, just add the configuration and
59-
`hvr-scripts` will use that instead of it's own internal config. In addition,
60-
`hvr-scripts` exposes its configuration so you can use it and override only
59+
`hover-scripts` will use that instead of it's own internal config. In addition,
60+
`hover-scripts` exposes its configuration so you can use it and override only
6161
the parts of the config you need to.
6262

6363
This can be a very helpful way to make editor integration work for tools like
@@ -67,19 +67,19 @@ So, if we were to do this for ESLint, you could create an `.eslintrc` with the
6767
contents of:
6868

6969
```
70-
{"extends": "./node_modules/hvr-scripts/eslint.js"}
70+
{"extends": "./node_modules/@hover/javascript/eslint.js"}
7171
```
7272

7373
Or, for `babel`, a `.babelrc` with:
7474

7575
```
76-
{"presets": ["hvr-scripts/babel"]}
76+
{"presets": ["@hover/javascript/babel"]}
7777
```
7878

7979
Or, for `jest`:
8080

8181
```javascript
82-
const {jest: jestConfig} = require('hvr-scripts/config')
82+
const {jest: jestConfig} = require('@hover/javascript/config')
8383
module.exports = Object.assign(jestConfig, {
8484
// your overrides here
8585

@@ -90,7 +90,7 @@ module.exports = Object.assign(jestConfig, {
9090
})
9191
```
9292

93-
> Note: `hvr-scripts` intentionally does not merge things for you when you start
93+
> Note: `hover-scripts` intentionally does not merge things for you when you start
9494
> configuring things to make it less magical and more straightforward. Extending
9595
> can take place on your terms. ~~I~~ _Kent_ thinks this is actually a great way to do this.
9696

0 commit comments

Comments
 (0)