save-ukraine 0.18.0 → 0.18.2

package/README.md

@@ -1,43 +1,112 @@
 # 🟦 Stop war on Ukraine 🟨
 
-**As a libertarian and programmer,** I would never think that I would someday work on a piece of software that would go against free access to any service from any corner of the world.
+Help Ukraine - add **ribbon with Ukraine flag** into the website you manage, show the **anti-war message to Russian users**, or **block them from your service**.
 
-But unfortunately, the situation has changed.
 
-Ukraine was attacked by Russia and a lot of innocent children, women and men are now dying in Kyiv and other Ukrainian cities at the hands of one cruel dictator.
 
-**This can not be tolerated in 21. century in Europe.**
+<!--Wallpaper-->
+<!--⚠️WARNING: This section was generated by https://github.com/hejny/batch-project-editor/blob/main/src//workflows/315-ai-generated-wallpaper/4-aiGeneratedWallpaperUseInReadme.ts so every manual change will be overwritten.-->
+[![Wallpaper of 🟦 Stop war on Ukraine 🟨](assets/ai/wallpaper/gallery/4d04f973-4bf7-4a8f-8b5a-05d0f9ca3c6e-0_0.png)](https://www.midjourney.com/app/jobs/4d04f973-4bf7-4a8f-8b5a-05d0f9ca3c6e)
+<!--/Wallpaper-->
 
-We can not just close our eyes and just provide all services and benefits to the Russian economy which can keep killing innocent people.
+A lot of companies did this in their custom way but this library is supereasy option to do for everyone.
 
-**If you are managing some website, please stop it for Russia** until the war will be over and putin overthrown.
+### 🎗️ Add ribbon with Ukraine flag on your website
 
----
 
-I don't want to punish the Russian people as a whole. As a citizen of Prague, I have few Russian friends and this definitely won't change. I believe most Russians do not support the politics of their state and especially this cruel war. But unfortunately, economic pressure is now one of the less bad solutions. And every ruble paid on taxes for the current Russian government means more money for killing innocent people.
+```html
+<script src="https://cdn.jsdelivr.net/npm/save-ukraine@0.18.0/dist/umd/main.js" integrity="sha384-Xn1RAG80M8PZlBQh3r8fUvHY7c8RtuplSnqXOkdJyCxqRsToRwJ1m2FP7vyJo7u/" crossorigin="anonymous"></script>
+<script>
+    Ukraine.save({
+        ribbon: 'TOP_LEFT',
+        hasShadow: true,
+        countries: [],
+    });
+</script>
+```
 
----
+![image](https://user-images.githubusercontent.com/23721952/157456259-c16c644d-4565-4018-b213-4d4918a05450.png)
 
-I have created a simple way how to do it.
 
-For the users **from other places, nothing happens or 🟦 you can optionally place the ribbon with Ukraine flag 🟨**. The script is tiny to load and insignificant. If the visitor is from **Russia or Belarus** _(detected by system language)_ this **message will appear**:
 
-https://github.com/hejny/Ukraine
+_Or use other method of installation see below._
 
-<!--Badges-->
-<!--⚠️WARNING: This section was generated by https://github.com/hejny/batch-project-editor/blob/main/src/workflows/800-badges/badges.ts so every manual change will be overwritten.-->
-<!--
-[![License of ✂️ Space trim](https://img.shields.io/github/license/hejny/Ukraine.svg?style=flat)](https://github.com/hejny/Ukraine/blob/main/LICENSE)
-[![NPM Version of ✂️ Space trim](https://badge.fury.io/js/Ukraine.svg)](https://www.npmjs.com/package/Ukraine)
-[![Quality of package ✂️ Space trim](https://packagequality.com/shield/Ukraine.svg)](https://packagequality.com/#?package=Ukraine)
-[![lint](https://github.com/hejny/Ukraine/actions/workflows/lint.yml/badge.svg)](https://github.com/hejny/Ukraine/actions/workflows/lint.yml)
-[![test](https://github.com/hejny/Ukraine/actions/workflows/test.yml/badge.svg)](https://github.com/hejny/Ukraine/actions/workflows/test.yml)
-[![Known Vulnerabilities](https://snyk.io/test/github/hejny/Ukraine/badge.svg)](https://snyk.io/test/github/hejny/Ukraine)
-[![Issues](https://img.shields.io/github/issues/hejny/Ukraine.svg?style=flat)](https://github.com/hejny/Ukraine/issues)
--->
-<!--/Badges-->
+### ❎ I want to show banner for Russian users
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/save-ukraine@0.18.0/dist/umd/main.js" integrity="sha384-Xn1RAG80M8PZlBQh3r8fUvHY7c8RtuplSnqXOkdJyCxqRsToRwJ1m2FP7vyJo7u/" crossorigin="anonymous"></script>
+<script>
+    Ukraine.save({
+        isCancelable: true,
+    });
+</script>
+```
+
+_Or use other method of installation see below._
+
+### 🛑 I want to block website for Russian users
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/save-ukraine@0.18.0/dist/umd/main.js" integrity="sha384-Xn1RAG80M8PZlBQh3r8fUvHY7c8RtuplSnqXOkdJyCxqRsToRwJ1m2FP7vyJo7u/" crossorigin="anonymous"></script>
+<script>
+    Ukraine.save({
+        isCancelable: false,
+    });
+</script>
+```
+
+![image](https://user-images.githubusercontent.com/23721952/157457857-05cc513e-b58c-4417-998b-bec93330d372.png)
+
+
+_Or use other method of installation see below._
+
+### 🩸 I want to show banner for Russian users but not include cruel graphic and blood
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/save-ukraine@0.18.0/dist/umd/main.js" integrity="sha384-Xn1RAG80M8PZlBQh3r8fUvHY7c8RtuplSnqXOkdJyCxqRsToRwJ1m2FP7vyJo7u/" crossorigin="anonymous"></script>
+<script>
+    Ukraine.save({
+        isBloodIncluded: false,
+        isGraphicIncluded: false,
+    });
+</script>
+```
+
+![image](https://user-images.githubusercontent.com/23721952/157458121-4718b34c-3efd-41fd-8f58-d06e5c5aed68.png)
+
+
+_Or use other method of installation see below._
+
+### 🎗️🎗️🎗️🎗️ I want to have ribbon in multiple corners
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/save-ukraine@0.18.0/dist/umd/main.js" integrity="sha384-Xn1RAG80M8PZlBQh3r8fUvHY7c8RtuplSnqXOkdJyCxqRsToRwJ1m2FP7vyJo7u/" crossorigin="anonymous"></script>
+<script>
+    Ukraine.save({
+        ribbon: 'TOP_LEFT',
+        hasShadow: true,
+        countries: [],
+    });
+    Ukraine.save({
+        ribbon: 'TOP_RIGHT',
+        hasShadow: false,
+        countries: [],
+    });
+    Ukraine.save({
+        ribbon: 'BOTTOM_LEFT',
+        hasShadow: true,
+        countries: [],
+    });
+    Ukraine.save({
+        ribbon: 'BOTTOM_RIGHT',
+        hasShadow: false,
+        countries: [],
+    });
+</script>
+```
+
+_Or use other method of installation see below._
 
-![Blood on Ukraine](./assets/wallpaper.png)
 
 ## 📲 How to include on your page?
 
@@ -48,21 +117,20 @@ There are several ways how to add this to your page:
 <!-- TODO: Auto update of version v0.13.0 -->
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/save-ukraine@0.18.0/dist/umd/main.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/save-ukraine@0.18.0/dist/umd/main.js" integrity="sha384-Xn1RAG80M8PZlBQh3r8fUvHY7c8RtuplSnqXOkdJyCxqRsToRwJ1m2FP7vyJo7u/" crossorigin="anonymous"></script>
 <script>
     Ukraine.save();
 </script>
 ```
 
-_Note:_ You can [also modify the options](https://github.com/hejny/Ukraine/blob/main/samples/browser.html#L10).
 _Note: Normally you would include **async** and **defer** keywords in the script element. But in this situation we do not want to defer this miniscript._
 
-📗 Wordpress
+### 📗 Wordpress
 
 Install [Simple Custom CSS and JS](https://cs.wordpress.org/plugins/custom-css-js/) WordPress plugin and add the following code as the `Custom HTML`:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/save-ukraine@0.18.0/dist/umd/main.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/save-ukraine@0.18.0/dist/umd/main.js" integrity="sha384-Xn1RAG80M8PZlBQh3r8fUvHY7c8RtuplSnqXOkdJyCxqRsToRwJ1m2FP7vyJo7u/" crossorigin="anonymous"></script>
 <script>
     Ukraine.save();
 </script>
@@ -108,9 +176,10 @@ ReactDOM.render(
     <>
         <div
             ref={(element) => {
-                if (element) {
-                    Ukraine.save({ element });
+                if (!element) {
+                    return;
                 }
+                Ukraine.save({ element, ...props });
             }}
         />
         {/*...Here will be rest of your app...*/}
@@ -131,9 +200,10 @@ export function SaveUkraine(props: Partial<Omit<IUkraineOptions, 'element'>>) {
     return (
         <div
             ref={(element) => {
-                if (element) {
-                    Ukraine.save({ element, ...props });
+                if (!element) {
+                    return;
                 }
+                Ukraine.save({ element, ...props });
             }}
         />
     );
@@ -158,83 +228,8 @@ ReactDOM.render(
 Note: Feel free to add more methods of importing
 -->
 
-## 🧩 Scenarios to use
-
-### 🎗️ I just want to add ribbon
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/save-ukraine@0.18.0/dist/umd/main.js"></script>
-<script>
-    Ukraine.save({
-        countries: [
-            /* Make this list empty */
-        ],
-        ribbon: 'TOP_LEFT',
-        hasShadow: true,
-    });
-</script>
-```
-
-_Or use other method of installation see above._
-
-### ❎ I want that users can cancel the message
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/save-ukraine@0.18.0/dist/umd/main.js"></script>
-<script>
-    Ukraine.save({
-        isCancelable: true,
-    });
-</script>
-```
-
-_Or use other method of installation see above._
-
-### 🖼️ I do not want to include cruel graphic and blood
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/save-ukraine@0.18.0/dist/umd/main.js"></script>
-<script>
-    Ukraine.save({
-        isBloodIncluded: false,
-        isGraphicIncluded: false,
-    });
-</script>
-```
-
-_Or use other method of installation see above._
-
-### 🎗️🎗️🎗️🎗️ I want to have ribbon in multiple corners
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/save-ukraine@0.18.0/dist/umd/main.js"></script>
-<script>
-    Ukraine.save({
-        ribbon: 'TOP_LEFT',
-        hasShadow: true,
-        countries: [],
-    });
-    Ukraine.save({
-        ribbon: 'TOP_RIGHT',
-        hasShadow: false,
-        countries: [],
-    });
-    Ukraine.save({
-        ribbon: 'BOTTOM_LEFT',
-        hasShadow: true,
-        countries: [],
-    });
-    Ukraine.save({
-        ribbon: 'BOTTOM_RIGHT',
-        hasShadow: false,
-        countries: [],
-    });
-</script>
-```
-
-_Or use other method of installation see above._
 
-### 🛠 Other customization
+## 🛠🧩 Other customization
 
 You can customize what will be shown.
 Here are all the [options](./src/options.ts). If you have some idea feel free to contribute via pull request.
@@ -256,6 +251,52 @@ Ukraine.save({
 
 When you import anything _(not only this script)_ on your page, please do not trust the publisher. Verify the code and **include only the specific version** not the wildcard of every future version.
 
+
+
+## ✉️ Motivation
+
+**As a libertarian and programmer,** I would never think that I would someday work on a piece of software that would go against free access to any service from any corner of the world.
+
+But unfortunately, the situation has changed.
+
+Ukraine was attacked by Russia and a lot of innocent children, women and men are now dying in Kyiv and other Ukrainian cities at the hands of one cruel dictator.
+
+**This can not be tolerated in 21. century in Europe.**
+
+We can not just close our eyes and just provide all services and benefits to the Russian economy which can keep killing innocent people.
+
+**If you are managing some website, please stop it for Russia** until the war will be over and putin overthrown.
+
+---
+
+I don't want to punish the Russian people as a whole. As a citizen of Prague, I have few Russian friends and this definitely won't change. I believe most Russians do not support the politics of their state and especially this cruel war. But unfortunately, economic pressure is now one of the less bad solutions. And every ruble paid on taxes for the current Russian government means more money for killing innocent people.
+
+---
+
+I have created a simple way how to do it.
+
+For the users **from other places, nothing happens or 🟦 you can optionally place the ribbon with Ukraine flag 🟨**. The script is tiny to load and insignificant. If the visitor is from **Russia or Belarus** _(detected by system language)_ this **message will appear**:
+
+
+<!--Badges-->
+<!--⚠️WARNING: This section was generated by https://github.com/hejny/batch-project-editor/blob/main/src/workflows/800-badges/badges.ts so every manual change will be overwritten.-->
+<!--
+[![License of ✂️ Space trim](https://img.shields.io/github/license/hejny/Ukraine.svg?style=flat)](https://github.com/hejny/Ukraine/blob/main/LICENSE)
+[![NPM Version of ✂️ Space trim](https://badge.fury.io/js/Ukraine.svg)](https://www.npmjs.com/package/Ukraine)
+[![Quality of package ✂️ Space trim](https://packagequality.com/shield/Ukraine.svg)](https://packagequality.com/#?package=Ukraine)
+[![lint](https://github.com/hejny/Ukraine/actions/workflows/lint.yml/badge.svg)](https://github.com/hejny/Ukraine/actions/workflows/lint.yml)
+[![test](https://github.com/hejny/Ukraine/actions/workflows/test.yml/badge.svg)](https://github.com/hejny/Ukraine/actions/workflows/test.yml)
+[![Known Vulnerabilities](https://snyk.io/test/github/hejny/Ukraine/badge.svg)](https://snyk.io/test/github/hejny/Ukraine)
+[![Issues](https://img.shields.io/github/issues/hejny/Ukraine.svg?style=flat)](https://github.com/hejny/Ukraine/issues)
+-->
+<!--/Badges-->
+
+## 📛 Make 3D printed bagge
+
+
+[![276990939_10221763639026308_8401530540848276183_n](https://user-images.githubusercontent.com/23721952/159365141-520da10f-0ff4-4941-84cc-22cdab7d7588.jpg)https://www.thingiverse.com/thing:5326034](https://www.thingiverse.com/thing:5326034)
+
+
 ## ⁉️ FAQ
 
 Few most common things aggregated from your questions:

package/assets/ai/wallpaper/current

@@ -0,0 +1 @@
+4d04f973-4bf7-4a8f-8b5a-05d0f9ca3c6e-0_0.png

package/assets/ai/wallpaper/imagine

@@ -0,0 +1,4 @@
+# Note: Each part is new input for imagine command
+#       And every first line will be searched during the harvesting phase
+
+Help Ukraine - add ribbon with Ukraine flag into the website you manage, show the anti-war message to Russian users, or block them from your service.

package/batch-project-editor.js

@@ -0,0 +1,5 @@
+// Configuration for https://github.com/hejny/batch-project-editor
+
+module.exports = {
+    ignoreWorkflows: ['license', 'badges', 'contributing', 'partners'],
+};

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "save-ukraine",
-    "version": "0.18.0",
-    "description": "Ban Russian users from your website; in context of Ukraine invasion",
+    "version": "0.18.2",
+    "description": "Help Ukraine - add ribbon with Ukraine flag into the website you manage, show the anti-war message to Russian users, or block them from your service.",
     "sideEffects": false,
     "module": "./dist/esm/main.js",
     "main": "./dist/umd/main.js",
@@ -16,7 +16,7 @@
     },
     "repository": {
         "type": "git",
-        "url": "git+https://github.com/hejny/Ukraine.git"
+        "url": "https://github.com/hejny/Ukraine"
     },
     "keywords": [],
     "author": "",