Skip to content

Commit

Permalink
Tweak README for consistency (#25)
Browse files Browse the repository at this point in the history
The documentation for the flags has inconsistent punctuation. This change remedies that as well as fixes an instance of mismatched plurality in the README.
  • Loading branch information
machawk1 authored Feb 24, 2023
1 parent 0a22427 commit 4ef9766
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,23 +41,23 @@ wacz create -f tests/fixtures/example-collection.warc

### -o --output

Explicitly declare the name of the wacz being created
Explicitly declare the name of the wacz being created.

```
wacz create tests/fixtures/example-collection.warc -o mywacz.wacz
```

### -t --text

Generates pages.jsonl page index with a full-text index, must be run in conjunction with --detect-pages. Will have no effect if run alone
Generates pages.jsonl page index with a full-text index, must be run in conjunction with --detect-pages. Will have no effect if run alone.

```
wacz create tests/fixtures/example-collection.warc -t
```

### --detect-pages

Generates pages.jsonl page index without a full-text index
Generates pages.jsonl page index without a full-text index.

```
wacz create tests/fixtures/example-collection.warc --detect-pages
Expand All @@ -73,47 +73,47 @@ wacz create tests/fixtures/example-collection.warc -p passed_pages.jsonl

### -t --text

You can add a full text index by including the --text tag
You can add a full text index by including the --text tag.

```
wacz create tests/fixtures/example-collection.warc -p passed_pages.jsonl --text
```

### --ts

Overrides the ts metadata value in the datapackage.json file
Overrides the ts metadata value in the datapackage.json file.

```
wacz create tests/fixtures/example-collection.warc --ts TIMESTAMP
```

### --url

Overrides the url metadata value in the datapackage.json file
Overrides the url metadata value in the datapackage.json file.

```
wacz create tests/fixtures/example-collection.warc --url URL
```

### --title

Overrides the titles metadata value in the datapackage.json file
Overrides the titles metadata value in the datapackage.json file.

```
wacz create tests/fixtures/example-collection.warc --title TITLE
```

### --desc

Overrides the desc metadata value in the datapackage.json file
Overrides the desc metadata value in the datapackage.json file.

```
wacz create tests/fixtures/example-collection.warc --desc DESC
```

### --hash-type

Allows the user to specify the hash type used: (sha256 or md5):
Allows the user to specify the hash type used (sha256 or md5).

```
wacz create tests/fixtures/example-collection.warc --hash-type md5
Expand Down Expand Up @@ -160,7 +160,7 @@ To run locally, the `authsign` must be installed, which can be done by running `

See [WACZ Authentication Spec](https://github.com/webrecorder/wacz-auth-spec) on WACZ authentication.

This feature and the specification are still in development (alpha-quality) and is subject to change.
This feature and the specification are still in development (alpha-quality) and are subject to change.



Expand Down

0 comments on commit 4ef9766

Please sign in to comment.