update dependencies and readme
This commit is contained in:
		
							
								
								
									
										24
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										24
									
								
								README.md
									
									
									
									
									
								
							| @@ -21,30 +21,6 @@ do more with npm | ||||
| ## Usage | ||||
| Use TypeScript for best in class instellisense. | ||||
|  | ||||
| The main purpose of npmextra is to configure different tools using one npmextra.json. This way complex setups avoid additional complexity caused by too many configuration files. | ||||
|  | ||||
| npmextra.json | ||||
| ```json | ||||
| { | ||||
|     "sometool": { | ||||
|         "defaultKey1": "awesomeValueFromConfig" | ||||
|     } | ||||
| } | ||||
| ``` | ||||
|  | ||||
| ```typescript | ||||
| import { Npmextra } from 'npmextra' | ||||
|  | ||||
| let myNpmExtra = new Npmextra('my/path/to/cwd') // cwd argument is optional  | ||||
| mergedData = myNpmExtra.dataFor( | ||||
|     'sometool', | ||||
|     { // gets merged with whatever is in the configfile | ||||
|         defaultKey1: 'defaultValue1', // so this will get overwritten with "awesomeValueFromConfig" | ||||
|         defaultKey2: 'defaultValue2' // this one will pass through unaltered | ||||
|     } | ||||
| ) | ||||
| ``` | ||||
|  | ||||
| For further information read the linked docs at the top of this README. | ||||
|  | ||||
| > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) | ||||
|   | ||||
| @@ -21,6 +21,7 @@ do more with npm | ||||
| ## Usage | ||||
| Use TypeScript for best in class instellisense. | ||||
|  | ||||
| ## Using npmextra for managing toolconfigs | ||||
| The main purpose of npmextra is to configure different tools using one npmextra.json. This way complex setups avoid additional complexity caused by too many configuration files. | ||||
|  | ||||
| npmextra.json | ||||
| @@ -45,6 +46,12 @@ mergedData = myNpmExtra.dataFor( | ||||
| ) | ||||
| ``` | ||||
|  | ||||
| ### Tools that already use the config feature of npmextra | ||||
|  | ||||
| * [npmts](https://www.npmjs.com/package/npmts) | ||||
| * [npmci](https://www.npmjs.com/package/npmci) | ||||
| * [npmdocker](https://www.npmjs.com/package/npmdocker) | ||||
|  | ||||
| For further information read the linked docs at the top of this README. | ||||
|  | ||||
| > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) | ||||
|   | ||||
| @@ -23,9 +23,10 @@ | ||||
|     "smartlodash": "^1.0.1", | ||||
|     "smartpath": "^3.2.8", | ||||
|     "smartq": "^1.1.6", | ||||
|     "tapbundle": "^1.1.1", | ||||
|     "taskbuffer": "^1.0.22", | ||||
|     "typings-global": "^1.0.19" | ||||
|   }, | ||||
|   "devDependencies": {} | ||||
|   "devDependencies": { | ||||
|     "tapbundle": "^1.1.1" | ||||
|   } | ||||
| } | ||||
|   | ||||
		Reference in New Issue
	
	Block a user