Skip to content

Commit effdf0e

Browse files
committed
Update readme and changelog
1 parent 6a9da62 commit effdf0e

2 files changed

Lines changed: 8 additions & 9 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ All notable changes to the `markdowntableprettify` extension will be documented
55
The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
66

77
## [Unreleased]
8+
9+
## 3.2.2 - 2020-01-11
810
### Added
911
- Issue #49: NPM package support.
1012

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![Test Status](https://github.com/darkriszty/MarkdownTablePrettify-VSCodeExt/workflows/Tests/badge.svg)](https://github.com/darkriszty/MarkdownTablePrettify-VSCodeExt/actions)
44
[![Visual Studio Code extension](https://img.shields.io/visual-studio-marketplace/v/darkriszty.markdown-table-prettify?color=success&label=VSCode)](https://marketplace.visualstudio.com/items?itemName=darkriszty.markdown-table-prettify)
55
[![Docker image](https://img.shields.io/docker/v/darkriszty/prettify-md?color=success&label=Docker)](https://hub.docker.com/r/darkriszty/prettify-md/tags?page=1&ordering=last_updated)
6-
[![npm package](https://img.shields.io/npm/v/markdown-table-prettify?color=success)](https://www.npmjs.com/package/markdown-table-prettify)
6+
[![NPM package](https://img.shields.io/npm/v/markdown-table-prettify?color=success)](https://www.npmjs.com/package/markdown-table-prettify)
77

88
Makes tables more readable for humans. Compatible with the Markdown writer plugin's table formatter feature in Atom.
99

@@ -62,18 +62,18 @@ Available features from docker:
6262

6363
## CLI
6464

65-
Formatting files or checking if they're already formatted is possible from the command line. This requires `node` and `npm`.
65+
Formatting files or checking if they're already formatted is possible from the command line. This requires `node` and `npm` (optionally also `npx`).
6666

6767
### Available features from the command line:
6868
- To prettify a file: `npm run --silent prettify-md < input.md`.
6969
- To prettify a file and save the output: `npm run --silent prettify-md < input.md > output.md`.
7070
- To check whether a file is prettyfied or not: `npm run --silent check-md < input.md`. This will fail with an exception and return code `1` if the file is not prettyfied.
7171

72-
> Note: the `--silent` switch sets the npm log level to silent, which is useful to hide the executed file name and concentrate on the actual output.
72+
> Note: the `--silent` switch sets the NPM log level to silent, which is useful to hide the executed file name and concentrate on the actual output.
7373
7474
### Installation
7575

76-
To access the CLI, the extension can either be used from the Github sources, from the install VSCode extension or from npm.
76+
To access the CLI, the extension can either be used from the Github sources, from the already instaledl VSCode extension or from NPM.
7777

7878
#### Compiling from the source code
7979

@@ -89,12 +89,9 @@ Locate the installed extension path. The typical location of the installed exten
8989
- macOS: `~/.vscode/extensions/darkriszty.markdown-table-prettify-{version}`
9090
- Linux: `~/.vscode/extensions/darkriszty.markdown-table-prettify-{version}`
9191

92-
#### Using it from npm
92+
#### Getting it from NPM
9393

94-
Install the npm package `npm install -g markdown-table-prettify`. Use `npx` to prettify files:
95-
- To prettify a file: `npx markdown-table-prettify < input.md`.
96-
- To prettify a file and save the output: `npx markdown-table-prettify < input.md > output.md`.
97-
- To check whether a file is prettyfied or not: `npx markdown-table-prettify --check < input.md`. This will fail with an exception and return code `1` if the file is not prettyfied.
94+
Install the NPM package `npm install -g markdown-table-prettify`. Optionally, use `npx` to prettify files: `npx markdown-table-prettify < input.md` (instead of `npm run --silent prettify-md < input.md`).
9895

9996
## Known Issues
10097

0 commit comments

Comments
 (0)