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