Skip to content

Update README.md #57

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.

Sign up for GitHub

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

Jump to bottom
Open
hefemk wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #57

hefemk wants to merge 1 commit into from

Conversation

@hefemk
Copy link

@hefemk hefemk commented Oct 14, 2023

Description

Update the description in README:

  • According to the installation instructions on npm, the correct command should be npm install @adobe/cgroup-metrics
  • cgroup.cpu() should actually be cgroup.cpu
  • cgroup.memory() should actually be cgroup.memory

Related Issue

#56

Motivation and Context

To prevent users from experiencing installation or usage difficulties.

Types of changes

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

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@hefemk