Use DB for usage examples.

.dockerignore

@@ -0,0 +1,15 @@
+*.swp
+*.swo
+db.sql
+words
+migrate/migrate
+words_image.tar
+loader_image.tar
+data/*.bz2
+commands.md
+cover.out
+testdata/*
+backups/*
+.vscode
+.git
+.cache

.gitignore

@@ -3,10 +3,14 @@ secret.go
 *.swo
 db.sql
 words
+migrate/migrate
 words_image.tar
+loader_image.tar
 data/*.csv
 data/*.bz2
 commands.md
 cover.out
 testdata/e2e_corrected.json
 backups/*
+
+.vscode/

Dockerfile

@@ -18,7 +18,7 @@ FROM golang:alpine AS builder
 RUN apk update && apk add --no-cache git gcc g++ ca-certificates apache2-utils
 WORKDIR /go/src/words
 COPY *.go ./
-Run go get -d -v -tags netgo -installsuffix netgo
+RUN go get -d -v -tags netgo -installsuffix netgo
 # netgo and ldflags makes sure that dns resolver and binary are statically
 # linked giving the ability for smaller images.
 RUN go build -tags netgo -installsuffix netgo -ldflags '-extldflags "-static"' -o /go/bin/words
@@ -28,6 +28,5 @@ FROM scratch
 # solution?
 COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
 COPY --from=builder /go/bin/words /go/bin/words
-COPY data/*.csv data/
 # TODO: This should be moved to the CMD starting it up.
 ENTRYPOINT ["/go/bin/words", "--db_path=/words-vol/db/db.sql"]

README.md

@@ -10,3 +10,23 @@ repository. It should live in data/links.csv and data/sentences.csv
 
 It can be downloaded from here:
 https://tatoeba.org/eng/downloads
+
+## QuickStart:
+1. Create a telegram bot using @BotFather if you don't have one yet
+2. Create secret.go in the root folder with the following content
+```go
+
+package main
+
+const BotToken = "TOKEN PROVIDED BY BOT FATHER"
+```
+3. Download links and senteces from https://tatoeba.org/eng/downloads
+4. Put fetched csv data under `./data`
+5. Run using one of the following:
+- using Go: `go build && ./words`
+- using Docker:
+```bash
+sudo docker volume create words-vol
+sudo docker build -t words .
+sudo docker run --rm --name words-app --mount source=words-vol,target=/words-vol/db/ words
+```