Updated LICENSE and README.md

Knuckles-Team · Oct 15, 2023 · 7af055a · 7af055a
1 parent e07a711
commit 7af055a
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 35 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,24 +1,20 @@
-This is free and unencumbered software released into the public domain.
+Copyright (c) 2012-2023 Audel Rouhi
 
-Anyone is free to copy, modify, publish, use, compile, sell, or
-distribute this software, either in source code form or as a compiled
-binary, for any purpose, commercial or non-commercial, and by any
-means.
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
 
-In jurisdictions that recognize copyright laws, the author or authors
-of this software dedicate any and all copyright interest in the
-software to the public domain. We make this dedication for the benefit
-of the public at large and to the detriment of our heirs and
-successors. We intend this dedication to be an overt act of
-relinquishment in perpetuity of all present and future rights to this
-software under copyright law.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
-OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
-
-For more information, please refer to <https://unlicense.org>
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,19 +1,44 @@
 # Webarchiver
+
+![PyPI - Version](https://img.shields.io/pypi/v/webarchiver)
+![PyPI - Downloads](https://img.shields.io/pypi/dd/webarchiver)
+![GitHub Repo stars](https://img.shields.io/github/stars/Knuckles-Team/webarchiver)
+![GitHub forks](https://img.shields.io/github/forks/Knuckles-Team/webarchiver)
+![GitHub contributors](https://img.shields.io/github/contributors/Knuckles-Team/webarchiver)
+![PyPI - License](https://img.shields.io/pypi/l/webarchiver)
+![GitHub](https://img.shields.io/github/license/Knuckles-Team/webarchiver)
+
+![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/Knuckles-Team/webarchiver)
+![GitHub pull requests](https://img.shields.io/github/issues-pr/Knuckles-Team/webarchiver)
+![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/Knuckles-Team/webarchiver)
+![GitHub issues](https://img.shields.io/github/issues/Knuckles-Team/webarchiver)
+
+![GitHub top language](https://img.shields.io/github/languages/top/Knuckles-Team/webarchiver)
+![GitHub language count](https://img.shields.io/github/languages/count/Knuckles-Team/webarchiver)
+![GitHub repo size](https://img.shields.io/github/repo-size/Knuckles-Team/webarchiver)
+![GitHub repo file count (file type)](https://img.shields.io/github/directory-file-count/Knuckles-Team/webarchiver)
+![PyPI - Wheel](https://img.shields.io/pypi/wheel/webarchiver)
+![PyPI - Implementation](https://img.shields.io/pypi/implementation/webarchiver)
+
 *Version: 0.29.0*
 
 Python tool that allows you to take full page screenshots of pages without ads
 
 Supports batching by adding multiple links in a text file, or my adding links to command line separated by commas.
 
-### Requirements:
+This repository is actively maintained - Contributions are welcome!
+
+#### Requirements:
 
 One of the following browsers:
 
 - Chrome/Chromium browser
 - Firefox
 - Selenoid Server
 
-### Usage:
+<details>
+  <summary><b>Usage:</b></summary>
+
 | Short Flag | Long Flag    | Description                                                |
 |------------|--------------|------------------------------------------------------------|
 | -h         | --help       | See Usage                                                  |
@@ -30,8 +55,11 @@ One of the following browsers:
 | -u         | --url-filter | Filter URL(s) that contain this string                     |
 | -z         | --zoom       | The zoom to use on the browser                             |
 
+</details>
+
+<details>
+  <summary><b>Example:</b></summary>
 
-### Example:
 ```bash
 webarchiver -c -f <links_file.txt> -l "<URL1,URL2,URL3>" -i 'jpeg' -d "~/Downloads" -z 100 --dpi 1 --browser "Firefox"
 ```
@@ -44,22 +72,25 @@ webarchiver -c -f <links_file.txt> -l "<URL1,URL2,URL3>" -i 'png' -d "~/Download
 webarchiver -s -f <links_file.txt> -l "<URL1,URL2,URL3>"
 ```
 
-#### Install Instructions
+</details>
+
+<details>
+  <summary><b>Installation Instructions:</b></summary>
+
 Install Python Package
 
 ```bash
 python -m pip install webarchiver
 ```
 
-#### Build Instructions
-Build Python Package
+</details>
 
-```bash
-sudo chmod +x ./*.py
-pip install .
-python setup.py bdist_wheel --universal
-# Test Pypi
-twine upload --repository-url https://test.pypi.org/legacy/ dist/* --verbose -u "Username" -p "Password"
-# Prod Pypi
-twine upload dist/* --verbose -u "Username" -p "Password"
-```
+<details>
+  <summary><b>Repository Owners:</b></summary>
+
+
+<img width="100%" height="180em" src="https://github-readme-stats.vercel.app/api?username=Knucklessg1&show_icons=true&hide_border=true&&count_private=true&include_all_commits=true" />
+
+![GitHub followers](https://img.shields.io/github/followers/Knucklessg1)
+![GitHub User's stars](https://img.shields.io/github/stars/Knucklessg1)
+</details>
diff --git a/setup.py b/setup.py
@@ -26,7 +26,7 @@
     url='https://github.com/Knuckles-Team/webarchiver',
     author=__author__,
     author_email='knucklessg1@gmail.com',
-    license='Unlicense',
+    license='MIT',
     packages=['webarchiver'],
     include_package_data=True,
     install_requires=[str(requirement.requirement) for requirement in requirements],