Skip to content

Commit

Permalink
add readme license and information
Browse files Browse the repository at this point in the history
  • Loading branch information
ranyitz committed Mar 6, 2018
1 parent 6830fd0 commit ac6ebd4
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 2 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2017 Ran Yitzhaki

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# qnm
> query node_modules
A simple cli utility for querying the `node_modules` directory.

## why?
> most bugs are caused by the assumptions we didn't realize we were making.
When debugging a problem, I sometimes find myself checking what are the **real™** versions of the modules within `node_modules` directory, i want to be able and check a specific module, list them all, get diffs between two repositories etc...

This tool should help me ease and improve this workflow.

## Installation
```bash
npm i --global qnm
```

## Usage
```bash
qnm [module]
```

For example, if you want to see the installed version of `lodash`:

```bash
qnm lodash
```

## License
The MIT License
9 changes: 7 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
{
"name": "qnm",
"version": "0.1.0",
"description": "query node_modules directory",
"description": "cli utility for querying the node_modules directory",
"bin": "bin/qnm.js",
"main": "workspace.js",
"repository": "ranyitz/qnm",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"engines": {
"node": ">=8.7"
},
"keywords": [
"query",
"node_modules",
"version"
"version",
"cli"
],
"author": "Ran Yitzhaki",
"license": "MIT",
Expand Down

0 comments on commit ac6ebd4

Please sign in to comment.