Skip to content

Commit d5a18c4

Browse files
committed
update: README.md
1 parent 06bad31 commit d5a18c4

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ Something else need to know:
3535

3636
# API
3737

38-
* Create a default engine, a typical 3-stage job:
38+
* Create default engine, a typical 3-stage job:
3939

40-
frontend: ``os_3m_engine.ootb.StdinFrontend``, read from stdin, send to transport stage
41-
transport: ``os_3m_engine.ootb.LogTransport``, log data received from fronted, send to backend stage
42-
backend: ``os_3m_engine.ootb.LogBackend``, log data received from transport
40+
- frontend: ``os_3m_engine.ootb.StdinFrontend``, read from stdin, send to transport stage
41+
- transport: ``os_3m_engine.ootb.LogTransport``, log data received from fronted, send to backend stage
42+
- backend: ``os_3m_engine.ootb.LogBackend``, log data received from transport
4343

4444
```
4545
from os_3m_engine.launcher import create
@@ -91,8 +91,8 @@ Something else need to know:
9191
9292
* Custom frontend class:
9393
94-
1. inherit from ``os_3m_engine.core.frontend.Frontend``
95-
2. define ``produce`` method as generator
94+
- inherit from ``os_3m_engine.core.frontend.Frontend``
95+
- define ``produce`` method as generator
9696
9797
```
9898
from os_3m_engine.core.frontend import Frontend
@@ -104,8 +104,8 @@ Something else need to know:
104104
105105
* Custom transport class:
106106
107-
1. inherit from ``os_3m_engine.core.transport.Transport``
108-
2. define ``transport`` method, the only parameter is the data received, the return value will be sent to backend
107+
- inherit from ``os_3m_engine.core.transport.Transport``
108+
- define ``transport`` method, the only parameter is the data received, the return value will be sent to backend
109109
110110
```
111111
from os_3m_engine.core.transport import Transport
@@ -117,8 +117,8 @@ Something else need to know:
117117
118118
* Custom backend class:
119119
120-
1. inherit from ``os_3m_engine.core.backend.Backend``
121-
2. define ``process`` method, the only parameter is the data received, no need return
120+
- inherit from ``os_3m_engine.core.backend.Backend``
121+
- define ``process`` method, the only parameter is the data received, no need return
122122
123123
```
124124
from os_3m_engine.core.backend import Backend
@@ -130,8 +130,8 @@ Something else need to know:
130130
131131
* Passing parameters
132132
133-
* create engine with custom config object
134-
* use ``self.config`` to get the config in stage class
133+
- create engine with custom config object
134+
- use ``self.config`` to get the config in stage class
135135
136136
```
137137
from os_3m_engine.launcher import create
@@ -143,7 +143,8 @@ Something else need to know:
143143
144144
* Custom ``setup``, ``cleanup`` behavior
145145
146-
each stage class can define ``setup``, ``cleanup`` methods, these will be called at each thread start/stop
146+
- each stage class can define ``setup``, ``cleanup`` methods
147+
- these will be called at each thread start/stop
147148
148149
149150
```

0 commit comments

Comments
 (0)