Added more options to run locally
authorAjay Bura <32841439+ajbura@users.noreply.github.com>
Wed, 15 Sep 2021 11:47:31 +0000 (17:17 +0530)
committerGitHub <noreply@github.com>
Wed, 15 Sep 2021 11:47:31 +0000 (17:17 +0530)
README.md

index e4995d9ab2f8157e654e74ceb79f3949bd292d3c..6679eaf36835ab5e88a8344b97b50838ee1e9ab1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,6 +14,11 @@ Cinny is a [Matrix](https://matrix.org) client focusing primarily on simple, ele
 
 ## Building and Running
 
+### Running pre-compiled
+
+A tarball of pre-compiled version of the app is provided with each [release](https://github.com/ajbura/cinny/releases).
+You can serve the application with a webserver of your choosing by simply copying `dist/` directory to the webroot.
+
 ### Building from source
 
 Execute the following commands to compile the app from its source code:
@@ -44,10 +49,12 @@ docker run -p 8080:80 cinny:latest
 This will forward your `localhost` port 8080 to the container's port 80. You can visit the app in your browser by
 navigating to `http://localhost:8080`.
 
+Alternatively you can just pull the [DockerHub image](https://hub.docker.com/r/ajbura/cinny) by `docker pull ajbura/cinny`.
+
 ## License
 
 Copyright (c) 2021 Ajay Bura (ajbura) and other contributors
 
 Code licensed under the MIT License: <http://opensource.org/licenses/MIT>
 
-Graphics licensed under CC-BY 4.0: <https://creativecommons.org/licenses/by/4.0/>
\ No newline at end of file
+Graphics licensed under CC-BY 4.0: <https://creativecommons.org/licenses/by/4.0/>