Skip to content

Commit cb279c7

Browse files
committed
adding README
1 parent 13aebc0 commit cb279c7

File tree

1 file changed

+94
-0
lines changed

1 file changed

+94
-0
lines changed

README.md

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
Creating a well-structured README.md file is essential for your project as it provides a clear overview of your project's purpose, usage, and instructions for potential contributors. Here's a sample README.md template for your image fetching library project:
2+
3+
```markdown
4+
# My Image Fetcher Library
5+
6+
My Image Fetcher Library is a C++ library that allows you to search for images on Google and download them to your local system. It provides a simple API for querying Google's Custom Search API and saving image results.
7+
8+
## Features
9+
10+
- Search for images on Google using keywords.
11+
- Download and save images to a specified folder.
12+
- Easily integrate image searching and downloading into your C++ applications.
13+
14+
## Prerequisites
15+
16+
Before using the library, you'll need the following:
17+
18+
- CMake (for building the project)
19+
- C++ Compiler (e.g., GCC)
20+
- cURL library (for making HTTP requests)
21+
22+
## Getting Started
23+
24+
### Installation
25+
26+
1. Clone this repository to your local machine:
27+
28+
```shell
29+
git clone https://github.com/pb2204/cpp-google-image-fetcher.git
30+
cd my-image-fetcher-library
31+
```
32+
33+
2. Build the library using CMake:
34+
35+
```shell
36+
mkdir build
37+
cd build
38+
cmake ..
39+
make
40+
```
41+
42+
### Usage
43+
44+
1. Include the library in your C++ project:
45+
46+
```cpp
47+
#include "google_image_fetcher.h"
48+
```
49+
50+
2. Create an instance of the `GoogleImageFetcher` class:
51+
52+
```cpp
53+
GoogleImageFetcher imageFetcher;
54+
```
55+
56+
3. Use the `fetchImages` method to search and download images:
57+
58+
```cpp
59+
imageFetcher.fetchImages("cat", "downloaded_images");
60+
```
61+
62+
This example searches for images of cats and saves them to the "downloaded_images" folder.
63+
64+
## Example
65+
66+
You can find a complete example of using the library in the [examples](/examples) directory.
67+
68+
## Contributing
69+
70+
Contributions are welcome! If you'd like to contribute to this project, please follow these steps:
71+
72+
1. Fork the repository.
73+
2. Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature-name`
74+
3. Make your changes and commit them: `git commit -m "Add your changes"`
75+
4. Push to your branch: `git push origin feature/your-feature-name`
76+
5. Open a pull request on this repository.
77+
78+
Please review the [Contributing Guidelines](CONTRIBUTING.md) for more details.
79+
80+
## License
81+
82+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
83+
84+
## Acknowledgments
85+
86+
- Thanks to the creators of cURL for the powerful HTTP request library.
87+
- Inspiration from other image-fetching libraries and APIs.
88+
89+
## Contact
90+
91+
If you have any questions, suggestions, or feedback, feel free to reach out to [Pabitra Banerjee](mailto:[email protected]).
92+
93+
Happy coding!
94+
```

0 commit comments

Comments
 (0)