Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add explicit install command to README.md #84

Merged
merged 1 commit into from
Dec 21, 2023

Conversation

JoshuaKGoldberg
Copy link
Collaborator

PR Checklist

Overview

Adds an explicit npm install dedent code block to the top of the README.md

@@ -27,6 +27,10 @@

## Usage

```shell
npm i dedent
```
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thoughts @jclaveau? 😄

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brilliant! ^^

Copy link
Collaborator

@Haroenv Haroenv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bit overkill, but it's common, so why not

@JoshuaKGoldberg JoshuaKGoldberg merged commit 87f0f9b into main Dec 21, 2023
10 of 12 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the docs-readme-install branch December 21, 2023 15:52
Copy link

🎉 This is included in version v1.5.2 🎉

The release is available on:

Cheers! 📦🚀

renovate bot referenced this pull request in JoshuaKGoldberg/eslint-plugin-expect-type Apr 13, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [dedent](https://togithub.com/dmnd/dedent) | [`1.5.1` ->
`1.5.2`](https://renovatebot.com/diffs/npm/dedent/1.5.1/1.5.2) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/dedent/1.5.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/dedent/1.5.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/dedent/1.5.1/1.5.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/dedent/1.5.1/1.5.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>dmnd/dedent (dedent)</summary>

### [`v1.5.2`](https://togithub.com/dmnd/dedent/releases/tag/v1.5.2)

[Compare
Source](https://togithub.com/dmnd/dedent/compare/v1.5.1...v1.5.2)

#### What's Changed

- chore: remove files related to Flow by
[@&#8203;yinm](https://togithub.com/yinm) in
[https://github.com/dmnd/dedent/pull/77](https://togithub.com/dmnd/dedent/pull/77)
- build: onboarded to create-typescript-app (mostly) by
[@&#8203;JoshuaKGoldberg](https://togithub.com/JoshuaKGoldberg) in
[https://github.com/dmnd/dedent/pull/55](https://togithub.com/dmnd/dedent/pull/55)
- chore: fix special characters escaping issue link in README by
[@&#8203;auvred](https://togithub.com/auvred) in
[https://github.com/dmnd/dedent/pull/82](https://togithub.com/dmnd/dedent/pull/82)
- chore: replace last yarn references with pnpm by
[@&#8203;JoshuaKGoldberg](https://togithub.com/JoshuaKGoldberg) in
[https://github.com/dmnd/dedent/pull/86](https://togithub.com/dmnd/dedent/pull/86)
- docs: add explicit install command to README.md by
[@&#8203;JoshuaKGoldberg](https://togithub.com/JoshuaKGoldberg) in
[https://github.com/dmnd/dedent/pull/84](https://togithub.com/dmnd/dedent/pull/84)
- fix: switch babel-plugin-macros to a peer dependency (again) by
[@&#8203;JoshuaKGoldberg](https://togithub.com/JoshuaKGoldberg) in
[https://github.com/dmnd/dedent/pull/89](https://togithub.com/dmnd/dedent/pull/89)
- build(deps-dev): bump
[@&#8203;babel/traverse](https://togithub.com/babel/traverse) from
7.22.8 to 7.23.6 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/dmnd/dedent/pull/87](https://togithub.com/dmnd/dedent/pull/87)
- fix: \n should be changed to \n only when escapeSpecialCharacters is
set by [@&#8203;fuenfundachtzig](https://togithub.com/fuenfundachtzig)
in
[https://github.com/dmnd/dedent/pull/91](https://togithub.com/dmnd/dedent/pull/91)

#### New Contributors

- [@&#8203;yinm](https://togithub.com/yinm) made their first
contribution in
[https://github.com/dmnd/dedent/pull/77](https://togithub.com/dmnd/dedent/pull/77)
- [@&#8203;auvred](https://togithub.com/auvred) made their first
contribution in
[https://github.com/dmnd/dedent/pull/82](https://togithub.com/dmnd/dedent/pull/82)
- [@&#8203;dependabot](https://togithub.com/dependabot) made their first
contribution in
[https://github.com/dmnd/dedent/pull/87](https://togithub.com/dmnd/dedent/pull/87)
- [@&#8203;fuenfundachtzig](https://togithub.com/fuenfundachtzig) made
their first contribution in
[https://github.com/dmnd/dedent/pull/91](https://togithub.com/dmnd/dedent/pull/91)

**Full Changelog**:
dmnd/dedent@v1.5.1...v1.5.2

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/JoshuaKGoldberg/eslint-plugin-expect-type).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yNjkuMiIsInVwZGF0ZWRJblZlciI6IjM3LjI2OS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
jcfranco referenced this pull request in Esri/calcite-design-system Apr 16, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [dedent](https://togithub.com/dmnd/dedent) | [`1.5.1` ->
`1.5.3`](https://renovatebot.com/diffs/npm/dedent/1.5.1/1.5.3) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/dedent/1.5.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/dedent/1.5.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/dedent/1.5.1/1.5.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/dedent/1.5.1/1.5.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>dmnd/dedent (dedent)</summary>

### [`v1.5.3`](https://togithub.com/dmnd/dedent/releases/tag/v1.5.3)

[Compare
Source](https://togithub.com/dmnd/dedent/compare/v1.5.2...v1.5.3)

#### What's Changed

- fix: remove engines and provenance requirements by
[@&#8203;JoshuaKGoldberg](https://togithub.com/JoshuaKGoldberg) in
[https://github.com/dmnd/dedent/pull/93](https://togithub.com/dmnd/dedent/pull/93)

**Full Changelog**:
dmnd/dedent@v1.5.2...v1.5.3

### [`v1.5.2`](https://togithub.com/dmnd/dedent/releases/tag/v1.5.2)

[Compare
Source](https://togithub.com/dmnd/dedent/compare/v1.5.1...v1.5.2)

#### What's Changed

- chore: remove files related to Flow by
[@&#8203;yinm](https://togithub.com/yinm) in
[https://github.com/dmnd/dedent/pull/77](https://togithub.com/dmnd/dedent/pull/77)
- build: onboarded to create-typescript-app (mostly) by
[@&#8203;JoshuaKGoldberg](https://togithub.com/JoshuaKGoldberg) in
[https://github.com/dmnd/dedent/pull/55](https://togithub.com/dmnd/dedent/pull/55)
- chore: fix special characters escaping issue link in README by
[@&#8203;auvred](https://togithub.com/auvred) in
[https://github.com/dmnd/dedent/pull/82](https://togithub.com/dmnd/dedent/pull/82)
- chore: replace last yarn references with pnpm by
[@&#8203;JoshuaKGoldberg](https://togithub.com/JoshuaKGoldberg) in
[https://github.com/dmnd/dedent/pull/86](https://togithub.com/dmnd/dedent/pull/86)
- docs: add explicit install command to README.md by
[@&#8203;JoshuaKGoldberg](https://togithub.com/JoshuaKGoldberg) in
[https://github.com/dmnd/dedent/pull/84](https://togithub.com/dmnd/dedent/pull/84)
- fix: switch babel-plugin-macros to a peer dependency (again) by
[@&#8203;JoshuaKGoldberg](https://togithub.com/JoshuaKGoldberg) in
[https://github.com/dmnd/dedent/pull/89](https://togithub.com/dmnd/dedent/pull/89)
- build(deps-dev): bump
[@&#8203;babel/traverse](https://togithub.com/babel/traverse) from
7.22.8 to 7.23.6 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/dmnd/dedent/pull/87](https://togithub.com/dmnd/dedent/pull/87)
- fix: \n should be changed to \n only when escapeSpecialCharacters is
set by [@&#8203;fuenfundachtzig](https://togithub.com/fuenfundachtzig)
in
[https://github.com/dmnd/dedent/pull/91](https://togithub.com/dmnd/dedent/pull/91)

#### New Contributors

- [@&#8203;yinm](https://togithub.com/yinm) made their first
contribution in
[https://github.com/dmnd/dedent/pull/77](https://togithub.com/dmnd/dedent/pull/77)
- [@&#8203;auvred](https://togithub.com/auvred) made their first
contribution in
[https://github.com/dmnd/dedent/pull/82](https://togithub.com/dmnd/dedent/pull/82)
- [@&#8203;dependabot](https://togithub.com/dependabot) made their first
contribution in
[https://github.com/dmnd/dedent/pull/87](https://togithub.com/dmnd/dedent/pull/87)
- [@&#8203;fuenfundachtzig](https://togithub.com/fuenfundachtzig) made
their first contribution in
[https://github.com/dmnd/dedent/pull/91](https://togithub.com/dmnd/dedent/pull/91)

**Full Changelog**:
dmnd/dedent@v1.5.1...v1.5.2

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 5am every weekday" in timezone
America/Los_Angeles, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/Esri/calcite-design-system).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4yOTMuMCIsInVwZGF0ZWRJblZlciI6IjM3LjI5My4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJjaG9yZSIsImRlcGVuZGVuY2llcyJdfQ==-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

📝 Docs: add an 'install' section to the README?
3 participants