Skip to content

Commit e2a4607

Browse files
committed
Beef up README
1 parent d0e618d commit e2a4607

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,47 @@ Python implementation of the [FlowBase micro-FBP framework
44
idea](https://flowbase.org), using Python's asyncio library, introduced in
55
Python 3.4/3.5.
66

7+
# Installation
8+
9+
```bash
10+
git clone git@github.com:flowbase/flowbase-python.git
11+
cd flowbase-python
12+
pip install .
13+
```
14+
15+
# Try an example
16+
17+
```
18+
cd examples
19+
python string_processing_pipeline.py
20+
```
21+
22+
## Expected output:
23+
24+
```bash
25+
$ python string_processing_pipeline.py
26+
Printer got line: hi hi for the 1:TH TIME...
27+
Printer got line: hi hi for the 2:TH TIME...
28+
Printer got line: hi hi for the 3:TH TIME...
29+
Printer got line: hi hi for the 4:TH TIME...
30+
Printer got line: hi hi for the 5:TH TIME...
31+
Printer got line: hi hi for the 6:TH TIME...
32+
Printer got line: hi hi for the 7:TH TIME...
33+
Printer got line: hi hi for the 8:TH TIME...
34+
Printer got line: hi hi for the 9:TH TIME...
35+
Printer got line: hi hi for the 10:TH TIME...
36+
Printer got line: hi hi for the 11:TH TIME...
37+
Printer got line: hi hi for the 12:TH TIME...
38+
Printer got line: hi hi for the 13:TH TIME...
39+
Printer got line: hi hi for the 14:TH TIME...
40+
Printer got line: hi hi for the 15:TH TIME...
41+
Printer got line: hi hi for the 16:TH TIME...
42+
Printer got line: hi hi for the 17:TH TIME...
43+
Printer got line: hi hi for the 18:TH TIME...
44+
Printer got line: hi hi for the 19:TH TIME...
45+
Printer got line: hi hi for the 20:TH TIME...
46+
```
47+
748
# Acknowledgements
849

950
Kudos to [Simone Baffelli](https://github.com/baffelli)'s

0 commit comments

Comments
 (0)