chimi - npm Package Compare versions

Comparing version 0.0.4 to 0.0.5

bin/bin.js

		@@ -10,4 +10,6 @@ #!/usr/bin/env node
		${chalk.bold.white('Options')}
		--file, -f File or glob matching multiple files (default: "README.md")
		--config, -c Use configuration from this file (default: ".chimirc")
		--file, -f File or glob matching multiple files (default: "README.md")
		--config, -c Use configuration from this file (default: ".chimirc")
		--help, -h Show help
		--version, -v, -V Show version

		@@ -27,2 +29,4 @@ ${chalk.bold.white('Examples')}
		h: 'help',
		v: 'version',
		V: 'version',
		},
		@@ -29,0 +33,0 @@ default: {

package.json

		{
		"name": "chimi",
		"version": "0.0.4",
		"version": "0.0.5",
		"description": "Run JavaScript snippets from your markdown files",
		@@ -5,0 +5,0 @@ "bin": {

readme.md

		@@ -9,2 +9,36 @@ # chimi

		## Installation

		```bash
		$ yarn add chimi --dev
		$ npm i chimi --save-dev

		# global works too

		$ yarn global add chimi
		$ npm i -g chimi
		```

		# Usage

		```
		Run JavaScript snippets from your markdown files

		Usage
		$ chimi -f <file> -c <config-file>

		Options
		--file, -f File or glob matching multiple files (default: "README.md")
		--config, -c Use configuration from this file (default: ".chimirc")
		--help, -h Show help
		--version, -v, -V Show version

		Examples
		$ chimi -f README.md

		$ chimi -f doc/*.md

		$ chimi -c chimi.config.js
		```

		## Configuration
		@@ -36,5 +70,6 @@
		```
		_NOTE_: _the `.chimirc` file has to be a valid JSON_.
		_NOTE_: _if it is a JavaScript file, an object has to be exported_.
		NOTE: _the `.chimirc` file has to be a valid JSON_.

		NOTE: _if it is a JavaScript file, an object has to be exported_.

		`dependencies`: `object`
		@@ -41,0 +76,0 @@

New alerts