Skip to content

Commit 0a4e8e4

Browse files
authored
Update README.md
1 parent 47aeb52 commit 0a4e8e4

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,50 @@
11
# string_py
2+
3+
4+
[![PyPI](https://img.shields.io/pypi/v/string-py?style=flat-square)](https://pypi.org/project/string-py/)
5+
6+
A Python package to simplify working with strings
7+
8+
## Installation
9+
10+
To install the library directly from PyPI you can just run the following command:
11+
```shell
12+
# Linux/macOS
13+
python3 -m pip install -U string-py
14+
15+
# Windows
16+
py -3 -m pip install -U string-py
17+
```
18+
19+
20+
## Format Example
21+
22+
```python
23+
from string_py import Format
24+
25+
print(Format.align(values={"Username:": "John", "Register Date:": "01.01.2001"}))
26+
```
27+
```
28+
Username: John
29+
Register Date: 01.01.2001
30+
```
31+
## Manipulation Example
32+
```python
33+
from string_py import Str
34+
35+
print(Str("Hello World!").first(5))
36+
```
37+
```
38+
Hello
39+
```
40+
## Printer Example
41+
```python
42+
from string_py import Printer
43+
44+
print = Printer()
45+
46+
print.time("Hello World!")
47+
```
48+
```
49+
[04.04 | 03:11:07] Hello World!
50+
```

0 commit comments

Comments
 (0)