Skip to content

Commit 3593a8b

Browse files
committed
Updating readme
1 parent 8901fee commit 3593a8b

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,29 @@ Far to much of the world runs on bash shell scripts. A shamefull amount of code,
66

77
This library hopes to bridge that gap
88

9-
## Setup
9+
## Setup for development
1010

11-
pip3 install virtualenv
12-
virtualenv -p python3 shellwrap
13-
cd shellwrap
14-
source bin/activate
15-
1611
get clone https://github.com/jceaser/shellwrap.git
1712
cd shellwrap
18-
./run.sh -b -i
13+
14+
pip3 install virtualenv
15+
virtualenv -p python3 .venv
16+
source .venv/bin/activate
17+
18+
./run.sh -I -b -i #Init build install
1919
python3 example.py
2020

21-
## Installing
21+
## Installing directly
2222

23-
pip3 install https://github.com/jceaser/shellwrap/releases/download/latest-master/shellwrap-0.0.1-py3-none-any.whl
23+
pip3 install https://github.com/jceaser/shellwrap/releases/download/latest-master/shellwrap-0.0.3-py3-none-any.whl
2424

2525
## Usage
2626

2727
### Printing in color
2828

29-
from shellwrap import color
30-
color.cprint(color.tcode.green, "Starting script", env)
29+
from shellwrap import color
30+
color.cprint(color.tcode.green, "Starting script", env)
31+
print(color.colorize(":rocket::blink:This is my :red:RED:end: text and this is my :green:GREEN:end: text."))
3132

3233
### Calling Unix Commands
3334

@@ -54,4 +55,4 @@ The function `interactivity()` will start a python shell with the scope of the `
5455
The function `user_commands()` is a little different. This ones will prompt the user for commands which are then handled by `process_actions(action=None, env:dict=None)`. This allows the calling function more control over what actions are offered. History is also remembered.
5556

5657
----
57-
Copyright © 2022 Thomas Cherry. This software is declared to be under the BSD license.
58+
Copyright © 2022-2025 Thomas Cherry. This software is declared to be under the BSD license.

0 commit comments

Comments
 (0)