From 7e0125b37b91641b1eff451790c59e38c8d96768 Mon Sep 17 00:00:00 2001
From: Farhanul Haque Khan <72323749+farhanulju@users.noreply.github.com>
Date: Wed, 13 Mar 2024 03:26:59 +0600
Subject: [PATCH] Create README.md

---
 README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9fd6819
--- /dev/null
+++ b/README.md
@@ -0,0 +1,78 @@
+# Skribbl.io Word Search Completion Tool
+
+A skribbl.io word search completion tool to guess words quickly based on hints. Improve your skribbl.io game performance with our efficient word search tool.
+
+## Features
+
+- Search for words based on partial patterns
+- Use underscore (`_`) as a placeholder for unknown letters
+- Real-time search results as you type
+- Displays the number of letters in the search pattern
+- Responsive and user-friendly interface
+
+## Installation
+
+1. Clone the repository:
+   ```
+   git clone https://github.com/your-username/skribbl-word-search.git
+   ```
+
+2. Navigate to the project directory:
+   ```
+   cd skribbl-word-search
+   ```
+
+3. Open the `index.html` file in your web browser.
+
+## Usage
+
+1. Open the skribbl.io word search completion tool in your web browser.
+
+2. Enter the partial word pattern in the search input field. Use underscore (`_`) as a placeholder for unknown letters.
+
+3. As you type, the tool will display real-time search results matching the entered pattern.
+
+4. The number of letters in the search pattern will be displayed below the search input field.
+
+5. Browse through the search results to find the desired word.
+
+## Contributing
+
+Contributions are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request.
+
+1. Fork the repository.
+
+2. Create a new branch:
+   ```
+   git checkout -b feature/your-feature
+   ```
+
+3. Make your changes and commit them:
+   ```
+   git commit -m 'Add some feature'
+   ```
+
+4. Push to the branch:
+   ```
+   git push origin feature/your-feature
+   ```
+
+5. Open a pull request.
+
+## Issues
+
+If you encounter any issues or have any questions, please [open an issue](https://github.com/farhanulju/Skribbl-Search/issues) on the GitHub repository.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+
+## Acknowledgements
+
+- [jQuery](https://jquery.com/) - JavaScript library used for DOM manipulation and AJAX requests.
+- 
+## Author
+
+- Farhanul Haque Khan
+- Email: 2017khan54@gmail.com
+- GitHub: [Farhanulju](https://github.com/farhanulju)