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

Update README.md about how to install #748

Merged
merged 3 commits into from
Feb 18, 2023
Merged

Conversation

cunzaizhuyi
Copy link
Contributor

Plan to do something drastic?
Leave an issue with a
summary of the changes you propose + some context on why you'd want to
do that, so we can have a conversation before you start. This will save you time!

Description

Update README.md about how to install

Motivation and Context

How Has This Been Tested?

  • green ci

Screenshots

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation only change
  • Refactor (non-breaking change which fixes an issue without changing functionality)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • 📖

    • My change doesn't require a documentation update, or ...
    • it does and I have updated it
  • ⚖️

    • The contribution will be subject to The MIT license, and I'm OK with that.
    • The contribution is my own original work.
    • I am ok with the stuff in CONTRIBUTING.md.

README.md Outdated
equivalent to install & save dependency-cruiser as a development dependency).
```javascript
npm install --save-dev dependency-cruiser
// or
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
// or
# or

README.md Outdated
@@ -20,8 +20,12 @@ you can stick on the wall to impress your grandma.

### Install it

- `npm install --save-dev dependency-cruiser` (with `yarn` or `pnpm` use their
equivalent to install & save dependency-cruiser as a development dependency).
```javascript
Copy link
Owner

Choose a reason for hiding this comment

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

Suggested change
```javascript
```shell

These commands call javascript, but they are run from the shell. Hence, usign ````shellin stead gives better highlighting (the-`'s don't look as syntax errors anymore :-) )

@sverweij
Copy link
Owner

Hi @cunzaizhuyi - thanks for this contribution, it indeed makes this section easier to read and use!

@sverweij sverweij merged commit 59bea92 into sverweij:develop Feb 18, 2023
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.

2 participants