Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
farhanulju authored Mar 12, 2024
1 parent 94e7852 commit 7e0125b
Showing 1 changed file with 78 additions and 0 deletions.
78 changes: 78 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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: [email protected]
- GitHub: [Farhanulju](https://github.com/farhanulju)

0 comments on commit 7e0125b

Please sign in to comment.