Skip to content

Commit daf54d3

Browse files
Add new installation instructions
1 parent 4f1b629 commit daf54d3

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@
1212
<!-- Badges -->
1313
<div align="center">
1414
<!-- Stability -->
15-
<img alt="GitHub Test State" src="https://github.com/Dog-Face-Development/PyAvatar/actions/workflows/test.yml/badge.svg">
16-
<!-- Stability -->
17-
<img alt="GitHub Build State" src="https://github.com/Dog-Face-Development/PyAvatar/actions/workflows/build.yml/badge.svg">
15+
<img alt="PyPI Build State" src="https://github.com/Dog-Face-Development/PyAvatar/actions/workflows/push-to-pypi.yml/badge.svg">
1816
<!-- Stability -->
1917
<img alt="Pylint State" src="https://github.com/Dog-Face-Development/PyAvatar/actions/workflows/pylint.yml/badge.svg">
2018
<!-- CodeQL -->
@@ -66,7 +64,11 @@ You can **[download](https://github.com/Dog-Face-Development/PyAvatar/releases/l
6664

6765
## How To Use
6866

69-
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:
67+
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.
68+
69+
### Git
70+
71+
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:
7072

7173
```bash
7274
# Clone this repository
@@ -75,10 +77,22 @@ $ git clone https://github.com/Dog-Face-Development/PyAvatar
7577
# Go into the repository
7678
$ cd PyAvatar
7779

78-
# Run the App
80+
# Run the CLI
7981
$ python main.py
8082
```
8183

84+
### `pip`
85+
86+
You can install the program from the [Python Package Index](https://pypi.org/project/PyAvatar/) through `pip`.
87+
88+
```bash
89+
# Install via pip
90+
$ pip install pyavatar
91+
92+
# Run the CLI
93+
$ pyavatar
94+
```
95+
8296
## Support
8397

8498
To view all available websites and their corresponding avatar's, just launch the app!

0 commit comments

Comments
 (0)