From b66d04c18cb02dbf5cfd79e9f0be9b39efe3bfde Mon Sep 17 00:00:00 2001
From: GMIKE <roman.soloweow333@ya.ru>
Date: Thu, 7 Mar 2024 21:40:47 +0000
Subject: [PATCH] update readme

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 7f24fe4..125c0d3 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,22 @@
-# SimpleStateMachine.StructuralSearch
\ No newline at end of file
+# SimpleStateMachine.StructuralSearch
+
+StructuralSearch - An easy-to-use library for structural search and replace in text in any programming language.
+
+## Give a Star! :star:
+If you like or are using this project please give it a star. Thanks!
+
+## Documentation📄
+Documentation here: https://github.com/SimpleStateMachine/SimpleStateMachine.StructuralSearch/wiki
+
+## FAQ❔
+If you think you have found a bug, create a github [issue](https://github.com/SimpleStateMachine/SimpleStateMachine.StructuralSearch/issues).
+
+But if you just have questions about how to use:
+
+- [Telegram channel](https://t.me/joinchat/HMLJFkv9do6aDV188rhd0w)
+
+## License📑
+
+Copyright (c) SimpleStateMachine
+
+Licensed under the [MIT](LICENSE) license.
\ No newline at end of file