Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sithulaka authored Sep 9, 2024
1 parent 1a839b4 commit 4aff9f2
Showing 1 changed file with 13 additions and 16 deletions.
29 changes: 13 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ PDF Translator is a Python-based tool designed to extract text from PDF document
### Clone the Repository

```bash
git clone <repository_url>
cd <repository_directory>
git clone https://github.com/sithulaka/pdf-translator.git
cd pdf-translator
```

### Set Up a Virtual Environment
Expand Down Expand Up @@ -99,19 +99,16 @@ We welcome contributions to improve this project. To contribute:
Please ensure that your contributions adhere to the project's coding standards and include tests where applicable.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

Feel free to reach out with any questions or feedback. Happy translating!

### Key Points in the README.md

1. **Overview**: Provides a concise description of the project and its features.
2. **Table of Contents**: Helps users quickly navigate the document.
3. **Installation**: Detailed steps for setting up the project, including cloning, setting up a virtual environment, and installing dependencies.
4. **Usage**: Instructions on how to use the script, including an example.
5. **Folder Structure**: Explains the organization of the project files and folders.
6. **Contributing**: Guidelines for contributing to the project.
7. **License**: Information about the licensing of the project.

This README.md provides a comprehensive and professional introduction to your project, making it easy for others to understand, use, and contribute.
## Contributing
Contributions are welcome! Please fork the repository and submit a pull request with your improvements or bug fixes.

## Connect with me
<p align="left">
<a href="https://linkedin.com/in/sithulaka" target="blank"><img align="center" src="https://github.com/sithulaka/sithulaka/blob/main/image/icon/linked-in-alt.svg" alt="sithulaka" height="30" width="40" /></a>
<a href="https://twitter.com/sithulaka" target="blank"><img align="center" src="https://github.com/sithulaka/sithulaka/blob/main/image/icon/twitter.svg" alt="sithulaka" height="30" width="40" /></a>
<a href="https://fb.com/senithu.sithulaka.7" target="blank"><img align="center" src="https://github.com/sithulaka/sithulaka/blob/main/image/icon/facebook.svg" alt="sithulaka" height="30" width="40" /></a>
<a href="https://instagram.com/_sithulaka_" target="blank"><img align="center" src="https://github.com/sithulaka/sithulaka/blob/main/image/icon/instagram.svg" alt="sithulaka" height="30" width="40" /></a>
<!-- <a href="https://discord.gg/ugdvth5b6H" target="blank"><img align="center" src="https://github.com/sithulaka/sithulaka/blob/main/image/icon/discord.svg" alt="sithulaka" height="30" width="40" /></a> -->
</p><br>

0 comments on commit 4aff9f2

Please sign in to comment.