Merge pull request #8 from ForceFledgling/dev

Updating documentation, logo, and project description.
ForceFledgling · Nov 8, 2023 · 2f31dcf · 2f31dcf
2 parents 70a69ce + b150cd7
commit 2f31dcf
Show file tree

Hide file tree

Showing 17 changed files with 4 additions and 795 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/README.md b/README.md
@@ -4,8 +4,12 @@
 ProxyHub
 ===========
 
+![logo](docs/img/logo_transparent.png)
+
 ProxyHub is an open source tool that asynchronously finds public proxies from multiple sources and concurrently checks them.
 
+[![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](docs)
+[![License: Apache License 2.0](https://img.shields.io/badge/License-Apache2-brightgreen.svg)](https://choosealicense.com/licenses/apache-2.0/)
 [![pypi Version](https://img.shields.io/pypi/v/proxyhub.svg?style=flat-square&logo=proxyhub&logoColor=white)](https://pypi.org/project/proxyhub/)
 [![PyPi downloads](https://static.pepy.tech/personalized-badge/proxyhub?period=total&units=international_system&left_color=grey&right_color=orange&left_text=pip%20downloads)](https://pypi.org/project/proxyhub/)
 
@@ -328,13 +332,6 @@ Contributing
 -   Submit a pull request!
 -   [Contributor workflow](https://github.com/ForceFledgling/proxyhub/issues/)
 
-License
--------
-
-Licensed under the Apache License, Version 2.0
-
-*This product includes GeoLite2 data created by MaxMind, available from* [<http://www.maxmind.com>](http://www.maxmind.com).
-
 ## Contributors ✨
 
 <!-- markdownlint-restore -->

diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/img/logo_transparent.png b/docs/img/logo_transparent.png
diff --git a/docs/source/_static/anonymous-128-icon.png b/docs/source/_static/anonymous-128-icon.png
diff --git a/docs/source/_static/anonymous-16-icon.ico b/docs/source/_static/anonymous-16-icon.ico
diff --git a/docs/source/_static/anonymous-logo.png b/docs/source/_static/anonymous-logo.png
diff --git a/docs/source/_static/cli_find_example.gif b/docs/source/_static/cli_find_example.gif
diff --git a/docs/source/_static/cli_grab_example.gif b/docs/source/_static/cli_grab_example.gif
diff --git a/docs/source/_static/cli_serve_example.gif b/docs/source/_static/cli_serve_example.gif
diff --git a/docs/source/_static/index_find_example.gif b/docs/source/_static/index_find_example.gif
diff --git a/docs/source/api.rst b/docs/source/api.rst
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst