Skip to content

Commit 458a527

Browse files
AseeefAseeef
committed
License & read me
1 parent 68f76b6 commit 458a527

File tree

2 files changed

+188
-1
lines changed

2 files changed

+188
-1
lines changed

‎LICENSE.txt

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Muhammad Aseef Imran
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+167-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,167 @@
1-
The Apache Proxy Pool is a proxy pool built for the Apache HttpClient framework.
1+
<!-- PROJECT SHIELDS -->
2+
<!--
3+
*** I'm using markdown "reference style" links for readability.
4+
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
5+
*** See the bottom of this document for the declaration of the reference variables
6+
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
7+
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
8+
-->
9+
[![Download][download-shield]][download-url]
10+
[![Jitpack][jitpack-shield]][jitpack-url]
11+
[![Contributors][contributors-shield]][contributors-url]
12+
[![Forks][forks-shield]][forks-url]
13+
[![Stargazers][stars-shield]][stars-url]
14+
[![Issues][issues-shield]][issues-url]
15+
[![MIT License][license-shield]][license-url]
16+
[![LinkedIn][linkedin-shield]][linkedin-url]
17+
18+
19+
20+
<!-- PROJECT LOGO -->
21+
<br />
22+
<div align="center">
23+
24+
<h3 align="center">Aseefian Proxy Pool [APP]</h3>
25+
26+
<p align="center">
27+
A pure-java library built for managing large number of proxies!
28+
<br />
29+
<a href="https://github.com/github_username/repo_name"><strong>Explore the docs »</strong></a>
30+
<br />
31+
<br />
32+
<a href="https://github.com/github_username/repo_name/issues">Report Bug</a>
33+
·
34+
<a href="https://github.com/github_username/repo_name/issues">Request Feature</a>
35+
</p>
36+
</div>
37+
38+
39+
40+
<!-- TABLE OF CONTENTS -->
41+
<details>
42+
<summary>Table of Contents</summary>
43+
<ol>
44+
<li>
45+
<a href="#about-the-project">About The Project</a>
46+
<ul>
47+
<li><a href="#features">Features</a></li>
48+
</ul>
49+
</li>
50+
<li>
51+
<a href="#getting-started">Getting Started</a>
52+
<ul>
53+
<li><a href="#prerequisites">Prerequisites</a></li>
54+
<li><a href="#installation">Installation</a></li>
55+
</ul>
56+
</li>
57+
<li><a href="#usage">Usage</a></li>
58+
<li><a href="#contributing">Contributing</a></li>
59+
<li><a href="#license">License</a></li>
60+
<li><a href="#contact">Contact</a></li>
61+
</ol>
62+
</details>
63+
64+
65+
66+
<!-- ABOUT THE PROJECT -->
67+
## About The Project
68+
69+
The Aseefian Proxy Pool (APP) is a thread safe framework for managing a large number of proxies. Written to be robust and flexible, the design philosophy of APP is written to give as much power over to the developers as possible. This flexibility lets you as the developer choose exactly how this proxy pool should behave.
70+
71+
### Features
72+
73+
* Built to be thread safe
74+
* Lightweight (with a shaded jar of 36kb)
75+
* Comes with a simple and built in framework for making HTTP requests
76+
* Built in with optional support for the Apache HTTP Client Framework
77+
* Supports using both HTTP and SOCKS5 proxies
78+
* Supports Proxy Authentication
79+
* Ability to "rotate" which proxies from the pool are being used
80+
* Built-in leak detections to analyze which requests are taking longer then they should.
81+
* Built-in proxy health check to automatically remove dead proxies from the pool
82+
* Vast flexibility to give developers full control over the high-level behavior of the pool
83+
84+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
85+
86+
<!-- GETTING STARTED -->
87+
## Getting Started
88+
89+
### Prerequisites
90+
91+
APP requires at least Java 8 or higher.
92+
93+
### Installation
94+
95+
APP maybe installed either via Maven or downloaded directly and then added as a dependency.
96+
97+
#### Maven
98+
99+
100+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
101+
102+
103+
104+
<!-- USAGE EXAMPLES -->
105+
## Usage
106+
107+
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
108+
109+
_For more examples, please refer to the [Documentation](https://example.com)_
110+
111+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
112+
113+
<!-- CONTRIBUTING -->
114+
## Contributing
115+
116+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
117+
118+
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
119+
Don't forget to give the project a star! Thanks again!
120+
121+
1. Fork the Project
122+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
123+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
124+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
125+
5. Open a Pull Request
126+
127+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
128+
129+
130+
131+
<!-- LICENSE -->
132+
## License
133+
134+
Distributed under the MIT License. See `LICENSE.txt` for more information.
135+
136+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
137+
138+
139+
140+
<!-- About the author -->
141+
## Contact
142+
143+
Muhammad Aseef Imran - [[email protected]](mail:[email protected])
144+
145+
Project Link: [https://github.com/Aseeef/AseefianProxyPool](https://github.com/Aseeef/AseefianProxyPool)
146+
147+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
148+
149+
150+
<!-- MARKDOWN LINKS & IMAGES -->
151+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
152+
[contributors-shield]: https://img.shields.io/github/contributors/Aseeef/AseefianProxyPool.svg?style=for-the-badge
153+
[contributors-url]: https://github.com/Aseeef/AseefianProxyPool/graphs/contributors
154+
[forks-shield]: https://img.shields.io/github/forks/Aseeef/AseefianProxyPool.svg?style=for-the-badge
155+
[forks-url]: https://github.com/Aseeef/AseefianProxyPool/network/members
156+
[stars-shield]: https://img.shields.io/github/stars/Aseeef/AseefianProxyPool.svg?style=for-the-badge
157+
[stars-url]: https://github.com/Aseeef/AseefianProxyPool/stargazers
158+
[issues-shield]: https://img.shields.io/github/issues/Aseeef/AseefianProxyPool.svg?style=for-the-badge
159+
[issues-url]: https://github.com/Aseeef/AseefianProxyPool/issues
160+
[license-shield]: https://img.shields.io/github/license/Aseeef/AseefianProxyPool.svg?style=for-the-badge
161+
[license-url]: https://github.com/Aseeef/AseefianProxyPool/blob/master/LICENSE.txt
162+
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
163+
[linkedin-url]: https://www.linkedin.com/in/aseef/
164+
[jitpack-shield]: https://img.shields.io/jitpack/version/com.github.Aseeef/AseefianProxyPool?style=for-the-badge
165+
[jitpack-url]: https://jitpack.io/#Aseeef/AseefianProxyPool/
166+
[download-shield]: https://img.shields.io/github/downloads/Aseeef/AseefianProxyPool/total?style=for-the-badge
167+
[download-url]: https://jitpack.io/#Aseeef/AseefianProxyPool/

0 commit comments

Comments
 (0)