Skip to content

Commit 86e894b

Browse files
author
Siddharth Yadav
committed
feat: update doc reflect removal of s3
1 parent d341fe5 commit 86e894b

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
# JSON Dereference CLI
22

3-
*Very* simple CLI tool that wraps the excellent [json-schema-ref-parser](https://github.com/BigstickCarpet/json-schema-ref-parser) library.
3+
*Very* simple CLI tool that wraps the
4+
excellent [json-schema-ref-parser](https://github.com/BigstickCarpet/json-schema-ref-parser) library.
45

56
## Usage
67

78
```bash
89
# Using npx:
9-
npx json-dereference-cli -s <schema> [-b <s3bucket>] [-i <spaces>] [-o <output>] [-t <type>]
10+
npx json-dereference-cli -s <schema> [-i <spaces>] [-o <output>] [-t <type>]
1011

1112
# Installing globally:
1213
npm install -g json-dereference-cli
13-
json-dereference -s <schema> [-b <s3bucket>] [-i <spaces>] [-o <output>] [-t <type>]
14+
json-dereference -s <schema> [-i <spaces>] [-o <output>] [-t <type>]
1415
```
1516

1617
*Note:* The input file can either be `json`, or `yaml` / `yml`.
1718

18-
*Note:* The output file types are either `json` or `yaml` / `yml`. This is determined from the file extension for the output file path passed in or using `-t json|yaml` when writing to stdout.
19-
20-
## Resolving s3 references
21-
22-
This CLI tool will also attempt to resolve S3 references (`$ref: "s3://.."`) using the `aws-sdk`. Take a look [here](s3-resolver.js) to see the custom resolver code.
19+
*Note:* The output file types are either `json` or `yaml` / `yml`. This is determined from the file extension for the
20+
output file path passed in or using `-t json|yaml` when writing to stdout.

0 commit comments

Comments
 (0)