Skip to content

Commit

Permalink
docs: clarify Server docs (#35)
Browse files Browse the repository at this point in the history
When working with this it was not immediately clear that the `version` parameter was not simply a string.

I figured it out reading the code, and hopefully this little update will be useful to others too.

Co-authored-by: Nathan Davies <[email protected]>
  • Loading branch information
nathj07 and nathj07 authored Apr 18, 2022
1 parent abac17b commit 8b4f630
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
*.jar

# editor files
*.idea
10 changes: 7 additions & 3 deletions tika/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,23 @@ Start with basic imports:
import "github.com/google/go-tika/tika"
You will need a running Server to make API calls to. So, if you don't
have a server that is already running and you don't have the Server
have a server that is already running, and you don't have the Server
JAR already downloaded, you can download one. The caller is responsible
for removing the file when no longer needed.
err := tika.DownloadServer(context.Background(), "1.16", "tika-server-1.16.jar")
Version is a custom type, and should be passed as such. There are constants in the code for these.
The following example downloads version 1.21 to the named JAR in the
current working directory.
err := tika.DownloadServer(context.Background(), tika.Version121, "tika-server-1.21.jar")
if err != nil {
log.Fatal(err)
}
If you don't have a running Tika Server, you can start one.
// Optionally pass a port as the second argument.
s, err := tika.NewServer("tika-server-1.16.jar", "")
s, err := tika.NewServer("tika-server-1.21.jar", "")
if err != nil {
log.Fatal(err)
}
Expand Down

0 comments on commit 8b4f630

Please sign in to comment.