Add README

This commit is contained in:
vanitasvitae 2017-06-19 20:40:13 +02:00
parent 12822d3f2e
commit e27ae15798
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311

20
README.md Normal file
View file

@ -0,0 +1,20 @@
# Home Made OMEMO Client
This is a repository containing the source code to my
[blog post](https://blogs.fsfe.org/vanitasvitae/2017/06/14/homemo/) about how to
build a home-made OMEMO chat application in less than 200 lines of code.
## Setup
You can clone the repository using `git clone https://git.fsfe.org/vanitasvitae/HomeMadeOmemo.git`
Next navigate to the root folder and compile using
```
cd HomeMadeOmemo/de.vanitasvitae.homemadeomemo
./gradlew build
```
## Run
You can run the application as follows:
```
java -jar build/libs/de.vanitasvitae.homemadeomemo.jar user@server.tld password
```