📝 Fix documentation

This commit is contained in:
C-3PO 2019-07-21 17:00:47 +02:00
parent e216cc35e3
commit 44bda57c89
Signed by: c3po
GPG key ID: 62993C4BB4D86F24

View file

@ -17,7 +17,7 @@ In the project where you want to use this library, add the following to your `pa
```json ```json
{ {
"dependencies": { "dependencies": {
"ssn": "git+https://git.jedipedia.net/swtor/argument-parser.git" "argument-parser": "git+https://git.jedipedia.net/swtor/argument-parser.git"
} }
} }
``` ```
@ -48,14 +48,14 @@ import parseArguments from 'argument-parser';
const { args, fail } = parseArguments({ const { args, fail } = parseArguments({
input: { input: {
short: 'i', short: 'i',
description: 'Path to the input file', description: 'Path to the input file'
}, },
size: { size: {
default: '0', default: '0',
short: 's', short: 's',
description: 'Size of the file, must be a non-negative integer', description: 'Size of the file, must be a non-negative integer',
verify: (str) => (str.match(/^[0-9]+$/) !== null), verify: str => str.match(/^[0-9]+$/) !== null
}, }
}); });
try { try {
@ -88,7 +88,7 @@ OPTIONS
## License ## License
Copyright (C) 2018 Jedipedia.net Copyright (C) 2018-2019 Jedipedia.net
This program is free software: you can redistribute it and/or modify This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as it under the terms of the GNU Affero General Public License as
@ -97,8 +97,8 @@ License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details. GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>. along with this program. If not, see <https://www.gnu.org/licenses/>.