Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
hansmi committed Dec 25, 2023
1 parent 8550148 commit b38818e
Showing 1 changed file with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,15 @@ formats can be implemented using custom parsers or by amending the library.
an alternative to imperative/procedural access.


## Installation

```shell
go get github.com/hansmi/dossier
```

Command line utility:

```shell
go install github.com/hansmi/dossier/cmd/dossiercli@latest
```


## Sketches

[Protocol buffers][protobuf] are used to define a sketch. The [sketch protobuf
definition](proto/sketch.proto) documents available configuration options.
Usually [textproto][textproto] will be the format used for writing sketches
[example sketch for invoices](/pkg/sketch/testdata/acme-invoice.textproto).
Usually [textproto][textproto] will be the format used for writing sketches.

A web-based viewer is included in the command line utility:
A web-based viewer is included in the command line utility. Screenshot of the
viewer with an [example sketch for
invoices](/pkg/sketch/testdata/acme-invoice.textproto):

![Graphical viewer showing an example invoice analysis](/docs/viewer-acme-invoice.png)

Expand All @@ -46,6 +34,19 @@ $ dossiercli web ./invoice.pdf ./sketch.textproto
```


## Installation

```shell
go get github.com/hansmi/dossier
```

Command line utility:

```shell
go install github.com/hansmi/dossier/cmd/dossiercli@latest
```


[releases]: https://github.com/hansmi/dossier/releases/latest
[mupdf]: https://mupdf.com/
[protobuf]: https://protobuf.dev/
Expand Down

0 comments on commit b38818e

Please sign in to comment.