From 72cd3d1b0fa955937b48bc740eb9ffbfd5de838f Mon Sep 17 00:00:00 2001 From: C-3PO Date: Fri, 2 Nov 2018 01:11:41 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=84=20Fix=20headings?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cd51885..39a451b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ +# argument-parser + This module parses the command line arguments into a JavaScript object, and verifies that they match the given specification. It checks that all required options are set, that no unknown options are used, and optionally that the arguments match a given pattern. The main goal is to keep all the complexity and error handling inside this module, so that all command line applications only need to provide a couple lines of specification and do not have to worry about verifying the input or checking for `undefined`. -# Installation +## Installation For this tool to work, the TypeScript compiler must be globally installed: @@ -26,7 +28,7 @@ Then run: npm install ``` -# Usage +## Usage This example shows how to use this module to check the arguments against a specification. @@ -84,7 +86,7 @@ OPTIONS Size of the file, must be a non-negative integer ``` -# License +## License Copyright (C) 2018 Jedipedia.net