-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6ed5b9b
commit 7cdcd05
Showing
3 changed files
with
69 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# 0.3.0 (2019-09-12) | ||
|
||
|
||
### Features | ||
|
||
* **cli:** add command to generate markdown from help documents ([4639b08](https://github.com/JamieMason/self-help/commit/4639b08)) | ||
* **cli:** add interactive self-help command ([0ec109d](https://github.com/JamieMason/self-help/commit/0ec109d)) | ||
* **core:** improve error messaging ([0061a48](https://github.com/JamieMason/self-help/commit/0061a48)) | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
# self-help | ||
|
||
Interactive Q&A Guides for Web and the Command Line | ||
|
||
## Installation | ||
|
||
This is a [Node.js](https://nodejs.org/) module available through the | ||
[npm registry](https://www.npmjs.com/). It can be installed using the | ||
[`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally) | ||
or | ||
[`yarn`](https://yarnpkg.com/en/) | ||
command line tools. | ||
|
||
```sh | ||
npm install self-help --save | ||
``` | ||
|
||
## Tests | ||
|
||
```sh | ||
npm install | ||
npm test | ||
``` | ||
|
||
## Dependencies | ||
|
||
- [chalk](https://ghub.io/chalk): Terminal string styling done right | ||
- [commander](https://ghub.io/commander): the complete solution for node.js command-line programs | ||
- [fs-extra](https://ghub.io/fs-extra): fs-extra contains methods that aren't included in the vanilla Node.js fs package. Such as mkdir -p, cp -r, and rm -rf. | ||
- [inquirer](https://ghub.io/inquirer): A collection of common interactive command line user interfaces. | ||
- [lodash](https://ghub.io/lodash): Lodash modular utilities. | ||
- [marked](https://ghub.io/marked): A markdown parser built for speed | ||
- [marked-terminal](https://ghub.io/marked-terminal): A custom render for marked to output to the Terminal | ||
- [xstate](https://ghub.io/xstate): Finite State Machines and Statecharts for the Modern Web. | ||
|
||
## Dev Dependencies | ||
|
||
- [@types/commander](https://ghub.io/@types/commander): Stub TypeScript definitions entry for commander, which provides its own types definitions | ||
- [@types/fs-extra](https://ghub.io/@types/fs-extra): TypeScript definitions for fs-extra | ||
- [@types/inquirer](https://ghub.io/@types/inquirer): TypeScript definitions for inquirer | ||
- [@types/jest](https://ghub.io/@types/jest): TypeScript definitions for Jest | ||
- [@types/lodash](https://ghub.io/@types/lodash): TypeScript definitions for Lo-Dash | ||
- [@types/marked](https://ghub.io/@types/marked): TypeScript definitions for Marked | ||
- [@types/marked-terminal](https://ghub.io/@types/marked-terminal): TypeScript definitions for marked-terminal | ||
- [@types/node](https://ghub.io/@types/node): TypeScript definitions for Node.js | ||
- [@types/prettier](https://ghub.io/@types/prettier): TypeScript definitions for prettier | ||
- [expect-more-jest](https://ghub.io/expect-more-jest): Write Beautiful Specs with Custom Matchers | ||
- [jest](https://ghub.io/jest): Delightful JavaScript Testing. | ||
- [prettier](https://ghub.io/prettier): Prettier is an opinionated code formatter | ||
- [rimraf](https://ghub.io/rimraf): A deep deletion module for node (like `rm -rf`) | ||
- [ts-jest](https://ghub.io/ts-jest): A preprocessor with source maps support to help use TypeScript with Jest | ||
- [tslint](https://ghub.io/tslint): An extensible static analysis linter for the TypeScript language | ||
- [typescript](https://ghub.io/typescript): TypeScript is a language for application scale JavaScript development | ||
|
||
## License | ||
|
||
MIT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
{ | ||
"name": "self-help", | ||
"description": "Interactive Q&A Guides for Web and the Command Line", | ||
"version": "0.0.0", | ||
"version": "0.3.0", | ||
"author": "Jamie Mason <[email protected]> (https://github.com/JamieMason)", | ||
"bin": { | ||
"self-help-interactive": "./dist/bin-interactive.js", | ||
|