Skip to content

Commit

Permalink
[Feature]: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
helabenkhalfallah committed May 26, 2024
1 parent 29c18c8 commit f8f05e8
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 9 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Maintainability Index is a software metric which measures how maintainable (easy
The maintainability index is calculated as a factored formula consisting of SLOC (Source Lines Of Code), Cyclomatic Complexity and Halstead volume.
It was originally developed by Oman & Hagemeister in the early 1990s. You can read more about it on [Wikipedia](https://learn.microsoft.com/en-us/visualstudio/code-quality/code-metrics-maintainability-index-range-and-meaning?view=vs-2022).

## How to use ?
## Installation and usage

1. Install the dependencies:
```
Expand All @@ -37,12 +37,14 @@ It was originally developed by Oman & Hagemeister in the early 1990s. You can re
npm run code-health-meter --srcDir "../../my-path" --outputDir "../../my-output-path" --outputFile "OutputFileName" --format "json or html"
```

Or with `npx`:
Or using `npx`:
```
npx code-health-meter --srcDir "../../my-path" --outputDir "../../my-output-path" --outputFile "OutputFileName" --format "json or html"
```

## How to contribute?
## Contributing

Contributions are welcome! Please read the contributing guidelines before getting started.

1. Clone the repository:
```
Expand All @@ -59,11 +61,7 @@ Or with `npx`:
```
npm run scan --srcDir "../../my-path" --outputDir "../../my-output-path" --outputFile "OutputFileName" --format "json or html"
```

## Contributing

Contributions are welcome! Please read the contributing guidelines before getting started.


## License

This project is licensed under the terms of the MIT license. See the LICENSE file for details.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "code-health-meter",
"version": "1.2.0",
"version": "1.2.1",
"description": "",
"main": "src/index.js",
"type": "module",
Expand Down

0 comments on commit f8f05e8

Please sign in to comment.