diff --git a/README.md b/README.md index 51af586c29583aa37688335cc1aa57324d30f40d..fdaf2e0eb0a73267989546cadfaa0c61fdb449f9 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,20 @@ -# Maunium sticker picker +# Matrix Sticker Picker -A fast and simple Matrix sticker picker widget. Tested on Element Web, Android & iOS. - -## Discussion - -Matrix room: [`#stickerpicker:maunium.net`](https://matrix.to/#/#stickerpicker:maunium.net) - -## Instructions - -For setup and usage instructions, please visit the [wiki](https://github.com/maunium/stickerpicker/wiki): - -- [Creating packs](https://github.com/maunium/stickerpicker/wiki/Creating-packs) -- [Enabling the widget](https://github.com/maunium/stickerpicker/wiki/Enabling-the-widget) -- [Hosting on GitHub pages](https://github.com/maunium/stickerpicker/wiki/Hosting-on-GitHub-pages) - -If you prefer video tutorials, [Brodie Robertson](https://www.youtube.com/c/BrodieRobertson) has made a great video on setting up the picker and creating some packs: https://youtu.be/Yz3H6KJTEI0. - -## Comparison with other sticker pickers - -- Scalar is the default integration manager in Element, which can't be self-hosted and only supports predefined sticker packs. -- [Dimension](https://github.com/turt2live/matrix-dimension) is an alternate integration manager. It can be self-hosted, but it's more difficult than Maunium sticker picker. -- Maunium sticker picker is just a sticker picker rather than a full integration manager. It's much simpler than integration managers, but currently has to be set up manually per-user. - -| Feature | Scalar | Dimension | Maunium sticker picker | -| ------------------------------- | ------ | --------- | ---------------------- | -| Free software | ⌠| âœ”ï¸ | âœ”ï¸ | -| Custom sticker packs | ⌠| âœ”ï¸ | âœ”ï¸ | -| Telegram import | ⌠| âœ”ï¸ | âœ”ï¸ | -| Works on Element mobiles | âœ”ï¸ | ⌠| âœ”ï¸ | -| Easy multi-user setup | âœ”ï¸ | âœ”ï¸ | âŒ<sup>[#7][#7]</sup> | -| Frequently used stickers at top | ⌠| ⌠| âœ”ï¸ | - -[#7]: https://github.com/maunium/stickerpicker/issues/7 +[ +](https://matrix.to/#/#stickers:baguette.party) +[](https://github.com/maunium/stickerpicker) ## Preview -| Web / Desktop | Android | iOS (Dark theme) | -| ---------------------------------------------- | ------------------------------------------------------ | ---------------------------------------------- | -|  |  |  | +Previews of the sticker picker with the different themes, and different accent colors applied (see section below), as well as different counts of stickers per row. + +| Light theme + Default accent | Dark theme + Pink accent | Black theme + Pink accent | +| ---------------------------- | ------------------------ | ------------------------- | +|  |  |  | ## Additional configuration -On an hosted instance of the sticker picker, it is possible to provide optional URL params for extended configuration : +It is possible to provide optional URL params for extended configuration : - `?config=<link to an index.json file>` - allows to use an external `index.json` file (see [packs/README.md](packs/README.md)) diff --git a/images/preview-black.png b/images/preview-black.png new file mode 100644 index 0000000000000000000000000000000000000000..b8abafcdd0006439ab42de55f20f6c94bf7c546c Binary files /dev/null and b/images/preview-black.png differ diff --git a/images/preview-dark.png b/images/preview-dark.png new file mode 100644 index 0000000000000000000000000000000000000000..72e9817274f92791257bb4eefc6a640581eb183e Binary files /dev/null and b/images/preview-dark.png differ diff --git a/images/preview-element-android.png b/images/preview-element-android.png deleted file mode 100644 index 0a7e720eaeb8ff8b2c9fe1f2fb4fd19ab1e427c4..0000000000000000000000000000000000000000 Binary files a/images/preview-element-android.png and /dev/null differ diff --git a/images/preview-element-ios.png b/images/preview-element-ios.png deleted file mode 100644 index dc3a44ef46b2a6a78058f67c908defe4085ce5ee..0000000000000000000000000000000000000000 Binary files a/images/preview-element-ios.png and /dev/null differ diff --git a/images/preview-element-web.png b/images/preview-element-web.png deleted file mode 100644 index 9aeb68045b1bbae7561514b0a72d298315ac3ea5..0000000000000000000000000000000000000000 Binary files a/images/preview-element-web.png and /dev/null differ diff --git a/images/preview-light.png b/images/preview-light.png new file mode 100644 index 0000000000000000000000000000000000000000..33da22d078423d15fb6310ab3e9aae6b7bb035e7 Binary files /dev/null and b/images/preview-light.png differ