Update README.md

[UltimateKEYS.git] / README.md

diff --git a/README.md b/README.md
index 95bdf942326309f9792a0c611bb218dc3bff1c57..93eb22a7d9887378955699e415ec11c87d597ce4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,20 @@
-# UltimateKEYS
-A fork based on the EurKEY Keyboard Layout (Windows).
+# UltimateKEYS Keyboard Layout (Windows/Linux)
+
+International US QWERTY layout with AltGr (Right Alt) dead keys via AutoHotkey scripts (Win), MSKLC sources (Win, see 'Testing' repository) and XKB integration (Linux, experimental). Derived from EurKEY (by Steffen Brüntjen).
+
+[![GitHub Release](https://img.shields.io/github/release/pieter-degroote/UltimateKEYS.svg)](https://github.com/pieter-degroote/UltimateKEYS/releases)
+
+## Important - Security Warning :
+
+**=> Win/Linux :  Only use "BASIC LATIN" characters (codes 32 to 126) for the Windows, Microsoft Live and Linux passwords !**  
+Otherwise, it might be impossible to type any Unicode character higher than "Basic Latin" at the login screen/prompt (due to a different keyboard configuration) ! **=> ACCOUNT LOCKOUT**
+
+**=> Win/Linux :  ALWAYS make your system passwords VISIBLE during modification !**
+
+## Website :  [ultimatekeys.info  (pieter-degroote.info)](https://pieter-degroote.github.io/UltimateKEYS/)
+
+## Releases :  https://github.com/pieter-degroote/UltimateKEYS/releases
+
+## Testing Repository - Additional experimental versions :
+
+## https://github.com/pieter-degroote/UltimateKEYS-testing