Skip to content

Commit 355e0f0

Browse files
committed
Update README, examples, and setup for version 2.0.0; add requirements.txt
1 parent 31d26ac commit 355e0f0

File tree

4 files changed

+16
-8
lines changed

4 files changed

+16
-8
lines changed

README.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
![yacpl intro gif](.assets/yacpl-intro.gif)
88
###### NOTE: this gif is horrible.
9-
## Installation
9+
## Installation:
1010

1111
```bash
1212
$ python3 -m pip install yacpl
@@ -15,10 +15,18 @@ $ python3 -m pip install yacpl
1515
## Usage:
1616

1717
```python
18-
from yacpl import Yacpl, Color
18+
from yacpl import Bg, Fg, Printer
19+
yacpl = Printer()
1920

20-
yacpl = Yacpl()
21-
22-
yacpl("Hello, World!", fg=Color.RED, bg=Color.WHITE) # bg is optional as it defaults to `Color.BLACK`
23-
# vscode should automatically pick up the colors too
21+
yacpl("Hello, world!", Bg.CYAN, Fg.RED)
2422
```
23+
24+
## Development:
25+
26+
```bash
27+
$ git clone https://github.com/fily-gif/yacpl.git # or `gh repo clone fily-gif/yacpl`
28+
$ python3 -m pip install -r requirements.txt
29+
# do your thing
30+
# to test your changes: do
31+
$ python3 -m pip install -e .
32+
```

examples/main.py

-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,3 @@
33
yacpl = Printer()
44

55
yacpl("Hello, world!", Bg.CYAN, Fg.RED)
6-
from yacpl import Yacpl, Color

requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
setuptools>=57.0

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
long_description = (this_directory / "README.md").read_text()
77
setup(
88
name='yacpl',
9-
version='1.0.8',
9+
version='2.0.0',
1010
packages=find_packages(),
1111
package_dir={'': '.'},
1212
long_description=long_description,

0 commit comments

Comments
 (0)