Skip to content

Commit 5c96447

Browse files
committed
Update README
1 parent d3bb1fb commit 5c96447

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# renovate-config-algolia
22

3-
This repository holds a [Renovate shareable configuration](https://renovateapp.com/docs/configuration-reference/config-presets), much like [algolia/eslint-config-algolia](https://github.com/algolia/eslint-config-algolia/).
3+
This repository holds a [Renovate shareable configuration](https://docs.renovatebot.com/config-presets/), much like [algolia/eslint-config-algolia](https://github.com/algolia/eslint-config-algolia/).
44

5-
[Renovate](https://renovateapp.com/) keeps npm dependencies up-to-date the right way, the right features and right time.
5+
[Renovate](https://www.mend.io/renovate/) keeps npm dependencies up-to-date the right way, the right features and right time.
66

77
## How to use it
88

@@ -12,21 +12,21 @@ If you have a **JavaScript application** (dashboard, static website generator),
1212

1313
```json
1414
{
15-
"extends": ["config:js-app", "algolia"]
15+
"extends": ["config:js-app", "github>algolia/renovate-config-algolia"]
1616
}
1717
```
1818

1919
If you have a **JavaScript library**:
2020

2121
```json
2222
{
23-
"extends": ["config:js-lib", "algolia"]
23+
"extends": ["config:js-lib", "github>algolia/renovate-config-algolia"]
2424
}
2525
```
2626

2727
The only difference between the two configurations is that an application will have its `devDependencies` _and_ `dependencies` pinned.
2828
While a JavaScript library will only have its `devDependencies` pinned.
29-
Read the [Renovate docs, dependency pinning](https://renovatebot.com/docs/dependency-pinning/) to learn more.
29+
Read the [Renovate docs, dependency pinning](https://docs.renovatebot.com/dependency-pinning/) to learn more.
3030

3131
You do not need to install `renovate-config-algolia`, as it's automatically picked up by Renovate.
3232

@@ -41,6 +41,6 @@ It will directly push to the GitHub default branch of your project.
4141

4242
It runs every weekend, Paris time.
4343

44-
We chose to have a configuration that directly pushes to GitHub to avoid any notification noise inside GitHub by having a lot of Pull Requests to merge manually.
44+
We chose to have a configuration that directly merges PRs to avoid having a lot of Pull Requests to merge manually.
4545
If the update passes your test suite, then it's merged directly.
46-
If tests are not passing or if there's a major upgrade then a pull request will be opened.
46+
If tests are not passing or if there's a major upgrade then the pull request will stay opened.

0 commit comments

Comments
 (0)