Skip to content

Commit c8ccedd

Browse files
committed
Changes to README and "./setup.py"
--- - Added new `*.gif` files to "./README.md" - Updated original `.gif` to display latest `VBPatcher` version. - Added new classifier to "./setup.py". - Added more keywords to "./setup.py". Signed-off-by: schlopp96 <71921821+schlopp96@users.noreply.github.com>
1 parent d93c271 commit c8ccedd

File tree

6 files changed

+21
-15
lines changed

6 files changed

+21
-15
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -112,21 +112,25 @@
112112

113113
- Within a terminal, open **VBP** with the following command:
114114

115-
```shell
116-
vbpatcher
117-
```
115+
- ```shell
116+
vbpatcher
117+
```
118+
119+
- ![alt](./assets/open_example.gif)
118120

119121
- Or optionally within a python environment:
120122

121-
```python
122-
>>> import VBPatcher # Import package
123-
>>> VBPatcher.vbp() # Call method to open program
124-
```
123+
- ```python
124+
>>> import VBPatcher # Import package
125+
>>> VBPatcher.vbp() # Call method to open program
126+
```
127+
128+
- ```python
129+
>>> from VBPatcher import vbp # Import package
130+
>>> vbp() # Call method to open program
131+
```
125132

126-
```python
127-
>>> from VBPatcher import vbp # Import package
128-
>>> vbp() # Call method to open program
129-
```
133+
- ![alt](./assets/open_in_python_example.gif)
130134

131135
- From here, follow the on-screen prompts to operate the program.
132136
- Choose an operation to run by entering the corresponding number (1-6) and pressing enter.
@@ -135,9 +139,9 @@
135139

136140
## Usage Example
137141

138-
- The following depicts the output from using **VBPatcher** from a command line to first check for any new updates before installing the latest base/stable-release of BepInEx, then the newest dev-build/bleeding-edge patch [option 3 in the program]:
142+
- The following depicts using **VBPatcher** from a command line to first check for any new updates before installing the latest base/stable-release of BepInEx, then the newest dev-build/bleeding-edge patch builds:
139143

140-
![alt](./assets/README-GIF.gif)
144+
- ![alt](./assets/usage_example.gif)
141145

142146
---
143147

assets/README-GIF.gif

-955 KB
Binary file not shown.

assets/open_example.gif

103 KB
Loading

assets/open_in_python_example.gif

241 KB
Loading

assets/usage_example.gif

874 KB
Loading

setup.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
name='VBPatcher',
1010
version='0.9.0',
1111
description=
12-
'The Valheim BepInEx Patcher (VBPatcher) is a personal script created to solve the weird automatic version downgrading of the BepInEx modding tool.',
12+
'The Valheim BepInEx Patcher (VBPatcher) is a CLI application for patching the Unity modding plugin, BepInEx, to its latest release (whether stable or bleeding-edge).',
1313
url='https://github.com/schlopp96/VBPatcher',
1414
author='schlopp96',
1515
author_email='schloppdaddy@gmail.com',
@@ -33,11 +33,13 @@
3333
"Programming Language :: Python :: 3.8",
3434
"Programming Language :: Python :: 3.9",
3535
"Programming Language :: Python :: 3.10",
36+
"Programming Language :: Python :: 3.11",
3637
"Topic :: Games/Entertainment",
3738
"Topic :: Utilities",
3839
],
3940
keywords=[
4041
'python,'
4142
'Valheim', 'BepInEx', 'patcher', 'mods', 'nexus', 'vbp', 'stable',
42-
'bleeding', 'edge', 'VBPatcher', 'vortex'
43+
'bleeding', 'edge', 'VBPatcher', 'vortex', 'patching', 'patch-install',
44+
'CLI', 'console'
4345
])

0 commit comments

Comments
 (0)