Add PGP public key and fix engine versions in package.json (#583)
authorKrishan <33421343+kfiven@users.noreply.github.com>
Fri, 27 May 2022 07:39:36 +0000 (13:09 +0530)
committerGitHub <noreply@github.com>
Fri, 27 May 2022 07:39:36 +0000 (13:09 +0530)
* nodejs 17.9.0 also works

* Add github sponser link

* Add Public PGP key of signed tarball

* Update README.md

* Add download badge also.

* Add docker pulls

.github/FUNDING.yml
README.md
package.json

index 2189f7f413809a5f2f439437731c0bf7efc1987a..e24e8dcf2d7edf09967dafdb6e05ce578e5d05fa 100644 (file)
@@ -1,2 +1,3 @@
+github: ajbura
+liberapay: ajbura
 open_collective: cinny
-liberapay: ajbura
\ No newline at end of file
index b35e5975050d855353a6f3b9c7cd0c472c3dfdbe..94a6e56b731ffb1351922ac1edd9838cc851d212 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,23 +1,27 @@
-# Cinny
+<p align="center">
+    <img src="https://raw.githubusercontent.com/ajbura/cinny/dev/public/res/svg/cinny.svg?sanitize=true"
+        height="16">
+    <span><b>Cinny</b></span>
+</p>
+<p align="center">
+    <a href="https://github.com/ajbura/cinny/releases">
+        <img alt="GitHub all releases" src="https://img.shields.io/github/downloads/ajbura/cinny/total?style=social"></a>
+    <a href="https://hub.docker.com/r/ajbura/cinny">
+        <img alt="GitHub all releases" src="https://img.shields.io/docker/pulls/ajbura/cinny?logo=docker&style=social"></a>
+    <a href="https://fosstodon.org/@cinnyapp">
+        <img src="https://img.shields.io/mastodon/follow/106845779685925461?domain=https%3A%2F%2Ffosstodon.org&style=social"></a>
+    <a href="https://twitter.com/intent/follow?screen_name=cinnyapp">
+        <img src="https://img.shields.io/twitter/follow/cinnyapp?style=social&logo=twitter"></a>
+    <a href="https://cinny.in/#sponsor">
+        <img src="https://img.shields.io/opencollective/all/cinny?style=social&logo=opencollective"></a>
+</p>
+
+**Cinny** is a Matrix client focusing primarily on simple, elegant and secure interface. The main goal is to have a client that is easy on end user 
+and feels a modern chat application.
 
-[![Star](https://img.shields.io/github/stars/ajbura/cinny)](https://github.com/ajbura/cinny/tree/dev)
-[![Chat](https://img.shields.io/badge/chat-on%20matrix-orange)](https://matrix.to/#/#cinny:matrix.org)
-[![Twitter](https://img.shields.io/twitter/url?url=https://twitter.com/@cinnyapp)](https://twitter.com/@cinnyapp)
-[![Support](https://img.shields.io/badge/sponsor-open%20collective-blue.svg)](https://opencollective.com/cinny)
-
-## Table of Contents
-
-- [About](#about)
-- [Getting Started](https://cinny.in)
 - [Contributing](./CONTRIBUTING.md)
 - [Roadmap](https://github.com/ajbura/cinny/projects/11)
 
-## About <a name = "about"></a>
-
-Cinny is a [Matrix](https://matrix.org) client focusing primarily on simple, elegant and secure interface.
-
-![preview](https://github.com/cinnyapp/cinny-site/blob/main/assets/preview-light.png)
-
 ## Building and Running
 
 ### Running pre-compiled
@@ -25,6 +29,54 @@ Cinny is a [Matrix](https://matrix.org) client focusing primarily on simple, ele
 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.
 
+<details>
+<summary>PGP Public Key to verify pre-compiled tarball</summary>
+
+```
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+mQGNBGJw/g0BDAC8qQeLqDMzYzfPyOmRlHVEoguVTo+eo1aVdQH2X7OELdjjBlyj
+6d6c1adv/uF2g83NNMoQY7GEeHjRnXE4m8kYSaarb840pxrYUagDc0dAbJOGaCBY
+FKTo7U1Kvg0vdiaRuus0pvc1NVdXSxRNQbFXBSwduD+zn66TI3HfcEHNN62FG1cE
+K1jWDwLAU0P3kKmj8+CAc3h9ZklPu0k/+t5bf/LJkvdBJAUzGZpehbPL5f3u3BZ0
+leZLIrR8uV7PiV5jKFahxlKR5KQHld8qQm+qVhYbUzpuMBGmh419I6UvTzxuRcvU
+Frn9ttCEzV55Y+so4X2e4ZnB+5gOnNw+ecifGVdj/+UyWnqvqqDvLrEjjK890nLb
+Pil4siecNMEpiwAN6WSmKpWaCwQAHEGDVeZCc/kT0iYfj5FBcsTVqWiO6eaxkUlm
+jnulqWqRrlB8CJQQvih/g//uSEBdzIibo+ro+3Jpe120U/XVUH62i9HoRQEm6ADG
+4zS5hIq4xyA8fL8AEQEAAbQdQ2lubnlBcHAgPGNpbm55YXBwQGdtYWlsLmNvbT6J
+AdQEEwEIAD4WIQSRri2MHidaaZv+vvuUMwx6UK/M8wUCYnD+DQIbAwUJA8JnAAUL
+CQgHAgYVCgkICwIEFgIDAQIeAQIXgAAKCRCUMwx6UK/M88ApC/9HAdbum1lYBC0s
+1k7GwP2A7B4sQtBWjy771BzybWlHeaeG+BGJwg4YiuowXZMm5dubFJFoI/CfeY07
+B5aK40/bmT6Xcfkp0VA74c1wUpubBUEJN7tH5HG/OGd9BKeq9E/HHtVaJLVT1k3w
+Rhv9VuHO6nR30EEp7IDthftotl5S4lio3+W0pKk4TAKV8vjaCNp3y/lAHzoP1BU9
+bUSao+7GXVeArKBjuqxN+t1uuiaxPH4L0oe2pMVjTig04zGJM5fTVoly859MEcC/
+R7Taq9RWGfXFmgCXy8Dviz3eOD90vqpCzhX4+ypK0cp2X0UwhMH4dpKUzExmdbhl
+eBO5GcHB4VxvloRBNf9/Lr7YOTgWejMUw+MlhZE2RE8unfW1LnM/cjL4dhXzO/XB
+FUHHNq8d6d4e02rfWqw7mZo2/NVJgFRcvzw2rgx7w7CKtCNwF4lNjUetB2waZzDb
+fAE0kwhK4Iuwvy12JOBzL0Yy9MxANtwUryr/LQz9AmdT4Rwnp0S5AY0EYnD+DQEM
+ANOu/d6ZMF8bW+Df9RDCUQKytbaZfa+ZbIHBus7whCD/SQMOhPKntv3HX7SmMCs+
+5i27kJMu4YN623JCS7hdCoXVO1R5kXCEcneW/rPBMDutaM472YvIWMIqK9Wwl5+0
+Piu2N+uTkKhe9uS2u7eN+Khef3d7xfjGRxoppM+xI9dZO+jhYiy8LuC0oBohTjJq
+QPqfGDpowBwRkkOsGz/XVcesJ1Pzg4bKivTS9kZjZSyT9RRSY8As0sVUN57AwYul
+s1+eh00n/tVpi2Jj9pCm7S0csSXvXj8v2OTdK1jt4YjpzR0/rwh4+/xlOjDjZEqH
+vMPhpzpbgnwkxZ3X8BFne9dJ3maC5zQ3LAeCP5m1W0hXzagYhfyjo74slJgD1O8c
+LDf2Oxc5MyM8Y/UK497zfqSPfgT3NhQmhHzk83DjXw3I6Z3A3U+Jp61w0eBRI1nx
+H1UIG+gldcAKUTcfwL0lghoT3nmi9JAbvek0Smhz00Bbo8/dx8vwQRxDUxlt7Exx
+NwARAQABiQG8BBgBCAAmFiEEka4tjB4nWmmb/r77lDMMelCvzPMFAmJw/g0CGwwF
+CQPCZwAACgkQlDMMelCvzPPT7Qv8CjXUEhphZFLwpBfaNOzRNfIXJST9aDit8zHW
+IMmfSpORVfpU71IyIB3o/DtTUPwCeb8nvNJs7aj1QT1ZUSsqFa3yY2S16V/g8+WN
+sHca6oDSc1J+A0eEpEL1HbG1b5OPBC0AeGvvMOoqrbqThBZVKg1Jc/0SD3cvKElv
+aHeCZCNNmfcZ2Ib4HYhhc8//ZtC9TeI+5J/YesctY1M12EoWMxMrc27Y3P5Pa0BI
+Uc3qxWggPq1vOFYsEshL0w99HyJvREJmQA7Fa0crV+rICxyrBxJeNnEvjH/0KCBU
+LCkEonLY1QwrxyeeV3VpxGE3zHHE3azOdAjTIoAdzX5f/qhbgYlM68GL2f8xdDkp
+O0igSGHWhO4F8BfmE7IOTx1Bi7daczp8nCFxh73cKpKB0RUsd9xxrqYpovjmEAlo
+w7aHpdzt64NQcsrbK10OSVDF3gFa9Vz20/NQvdUrp8jGmAb/8+nYqI94Jsc28H36
+UeGsouhyuITLwEhScounZDqop+Dx
+=Zg+6
+-----END PGP PUBLIC KEY BLOCK-----
+```
+</details>
+
 ### Building from source
 > We recommend using a version manager as versions change very quickly. You will likely need to switch 
 between multiple Node.js versions based on the needs of different projects you're working on. [NVM on windows](https://github.com/coreybutler/nvm-windows#installation--upgrades) on Windows and [nvm](https://github.com/nvm-sh/nvm) on Linux/macOS are pretty good choices. Also recommended nodejs version is 16.15.0 LTS.
@@ -38,7 +90,7 @@ npm run build # Compiles the app into the dist/ directory
 
 You can then copy the files to a webserver's webroot of your choice.
 
-To serve a development version of the app locally for testing, you may also use the command `npm start`.
+To serve a development version of the app locally for testing, you need to use the command `npm start`.
 
 ### Running with Docker
 
index 599b5e1178d83f4a02e6330f6074e13d1690612a..72d65bc89bc66d67c85654842ef9b7575dac721a 100644 (file)
@@ -4,8 +4,8 @@
   "description": "Yet another matrix client",
   "main": "index.js",
   "engines": {
-    "npm": ">=6.14.8 <8.5.5",
-    "node": ">=14.15.0 <17.9.0"
+    "npm": ">=6.14.8 <=8.5.5",
+    "node": ">=14.15.0 <=17.9.0"
   },
   "scripts": {
     "start": "webpack serve --config ./webpack.dev.js --open",