diff --git a/README.md b/README.md index acdcd92..24aa72b 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ When contributing, please follow the following (common-sense) steps: - If you are after a 1-5 line fix, you might ignore this. - In the pull-request explain the high-level goal and your approach. That provides valuable context. - Convince others (and yourself) that the change is safe and sound. - - Run `./gradlew connectedAndroidTest` and manually test the APK in release configuration using `./gradlew installDebug`. + - Run `./gradlew connectedAndroidTest` and manually test the APK in release configuration using `./gradlew installRelease`. ## Sample app 📱 @@ -79,3 +79,16 @@ When contributing, please follow the following (common-sense) steps: The repository comes with a sample app that you can install both in debug and release configuration. Just run `./gradlew installDebug` or `./gradlew installRelease` respectively. + +## Reference/BibText 📚 + +If you want to reference Argon2Kt in documentation or articles, feel free to use this suggested BibTex snippet: + +``` +@misc{hugenroth2019argon2kt, + author={{Daniel Hugenroth}}, + title={Argon2Kt}, + year={2019}, + url={https://github.com/lambdapioneer/argon2kt}, +} +```