Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
camdendotlol committed Jan 6, 2025
1 parent 0079272 commit cbdeabb
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,16 @@ editioncrafter process -i <tei_file> -o <output_path> -u <base_url>
```
This will create all of the artifacts that EditionCrafter needs in order to display your document on the web, and place them in the specified `<output_path>` folder. The `<base_url>` parameter should be the URL at which you intend to host these artifacts.

### `database`

Process the TEI document into a SQLite file containing a directory of categories and tags. This can be used with the Record List component from the EditionCrafter viewer package, or it can be browsed directly with a SQLite viewer.

Usage: `editioncrafter database [-i tei_file] [-o output_path]`

Required parameters:
* -i tei_file
* -o output_path (must end in .sqlite)

## Command line options

### `-c` or `--config`
Expand Down

0 comments on commit cbdeabb

Please sign in to comment.