Merge pull request #14 from Dog-Face-Development/willtheorangeguy-pypi-install

Add new installation instructions

Author: willtheorangeguy

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [v0.2.0](https://github.com/Dog-Face-Development/PyAvatar/releases/tag/v0.2.0)
+
+### Added
+
+- Python package.
+
 ## [v0.1.0](https://github.com/Dog-Face-Development/PyAvatar/releases/tag/v0.1.0)
 
 ### Added

README.md

@@ -12,9 +12,7 @@
 <!-- Badges -->
 <div align="center">
   <!-- Stability -->
-  <img alt="GitHub Test State" src="https://github.com/Dog-Face-Development/PyAvatar/actions/workflows/test.yml/badge.svg">
-  <!-- Stability -->
-  <img alt="GitHub Build State" src="https://github.com/Dog-Face-Development/PyAvatar/actions/workflows/build.yml/badge.svg">
+  <img alt="PyPI Build State" src="https://github.com/Dog-Face-Development/PyAvatar/actions/workflows/push-to-pypi.yml/badge.svg">
   <!-- Stability -->
   <img alt="Pylint State" src="https://github.com/Dog-Face-Development/PyAvatar/actions/workflows/pylint.yml/badge.svg">
   <!-- CodeQL -->
@@ -66,7 +64,11 @@ You can **[download](https://github.com/Dog-Face-Development/PyAvatar/releases/l
 
 ## How To Use
 
-To clone and run this application, you'll need [Git](https://git-scm.com/downloads) and [Python](https://www.python.org/downloads/) installed on your computer. If you would rather not use Git, you can just download the scripts from GitHub above. From your command line:
+To run the application, you can use [Git and the Python Interpreter](https://github.com/Dog-Face-Development/PyAvatar/main/README.md#git), which allows you to clone and run the application, or [`pip`](https://github.com/Dog-Face-Development/PyAvatar/main/README.md#pip) to create a command line application.
+
+### Git
+
+To clone and run this application, you'll need [Git](https://git-scm.com/downloads) and [Python](https://www.python.org/downloads/) installed on your computer. If you would rather not use Git, you can just download the script from GitHub above. From your command line:
 
 ```bash
 # Clone this repository
@@ -75,10 +77,22 @@ $ git clone https://github.com/Dog-Face-Development/PyAvatar
 # Go into the repository
 $ cd PyAvatar
 
-# Run the App
+# Run the CLI
 $ python main.py
 ```
 
+### `pip`
+
+You can install the program from the [Python Package Index](https://pypi.org/project/PyAvatar/) through `pip`.
+
+```bash
+# Install via pip
+$ pip install pyavatar
+
+# Run the CLI
+$ pyavatar
+```
+
 ## Support
 
 To view all available websites and their corresponding avatar's, just launch the app!

docs/USAGE.md

@@ -1,19 +1,26 @@
 # PyAvatar Usage
 
-To install PyAvatar, you can either use an executable package (Windows), or run the scripts through Python (Windows, macOS, Linux).
+To install PyAvatar, you can use an executable package (Windows), run the scripts through Python (Windows, macOS, Linux), or install from the [Python Package Index](https://pypi.org/).
 
 ## Executable Package
 
 1. To run the executable package, download the latest `.zip` file from [GitHub Releases](https://github.com/Dog-Face-Development/PyAvatar/releases/latest) page.
 2. Extract the `.zip` file using a program like [7-Zip](https://www.7-zip.org/).
 3. _(Optional) Move the files to `C:\Program Files` and create a shortcut._
-4. Double click on `main.exe`.
+4. Double click on `send.exe`.
 5. Enjoy the program!
 
 ## Python Script
 
 1. To run the Python script, download the latest source code release from [GitHub Releases](https://github.com/Dog-Face-Development/PyAvatar/releases/latest) page.
 2. Download and install [Python](https://www.python.org/downloads/).
 3. Extract the source code files using a program like [7-Zip](https://www.7-zip.org/).
-4. Double click on `main.py`, or right-click and open with IDLE and press `F5`.
+4. Double click on `send.py`, or right-click and open with IDLE and press `F5`.
 5. Enjoy the program!
+
+## Python Package Index (`pip`)
+
+1. Download and install [Python](https://www.python.org/downloads/).
+2. Open a terminal and run the command: `pip install pyavatar`.
+3. Start the program by running the command: `pyavatar`.
+4. Enjoy the program!