Skip to content

Commit

Permalink
Small doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ValentinVignal committed May 20, 2020
1 parent e94b528 commit 5a56f1a
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
# LoadBar
Python Librairy for a loading bar in the console

This is a very simple python library to create a loading bar on the shell

## Install it

```
pip install load-bar
```

## Use it

``` python
import time
from loadbar import LoadBar
bar = LoadBar(max=100)
bar.start()
for i in range(100):
time.sleep(0.05)
bar.update(step=i)
bar.end()
```

See the doc
11 changes: 11 additions & 0 deletions doc/loadbar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# LoadBar

## Install it

## Use it

## Options

## ColorBar

## RainbowBar

0 comments on commit 5a56f1a

Please sign in to comment.