adobe / adobe/node-cgroup-metrics

Update the description in README

Open
#56 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
18
Forks
4
PR merge metrics
No merged PRs in 30d

Description

### Expected Behaviour

In the current README:
- According to the installation instructions on [npm](https://www.npmjs.com/package/@adobe/cgroup-metrics), the correct command should be `npm install @adobe/cgroup-metrics`
- `cgroup.cpu()` should actually be `cgroup.cpu`,
- `cgroup.memory()` should actually be `cgroup.memory`

Contributor guide

Open the contributing guide

Research direction

Open the README and compare its installation command and cgroup.cpu() and cgroup.memory() examples with the issue and the npm package information. Done means the README uses npm install @adobe/cgroup-metrics and documents cgroup.cpu and cgroup.memory without parentheses.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, nodejs
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.