Skip to content

Commit b8da665

Browse files
authored
Update Readme
1 parent 7e416ff commit b8da665

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
[![Platform](https://img.shields.io/cocoapods/p/Flow.svg?style=flat)](http://cocoapods.org/pods/Flow)
66

77
## What's Flow
8-
Flow is an utility/ design pattern that help developers to write simple and readable codes.
8+
Flow is an utility/ design pattern that help developers to write simple and readable code.
99
There are two main concerns:
1010
`Flow of operations and Flow of data`
1111

1212
By using Flow, we should able to achieve the followings:
1313
- Logics / operations can be reused easily
1414
- The logic flows are readable by anyone (including the code reviewers)
15-
- Each line of codes is meaningfully and avoid ambiguous keywords
15+
- Each line of code is meaningfully and avoid ambiguous keywords
1616
- No more callback hell for complicated async operations
1717
- Debuggable both at development and production stage
1818

@@ -35,8 +35,8 @@ Here is an example for simple usage:
3535
In these 5 lines of code, we can know that two operations will be executed in serial and able to do something before and after the operations.
3636

3737
## Naming
38-
To make the logic readable, it is important to make the operation's name meaningfully. It is developer's responsibility to make a good name. Also, the name also determine the degree of reusable of codes.
39-
e.g. If you create an operation named: `SimplePrintOp`, it should contain only the codes to print the message associated with it. You should NOT do anything out of the context of the name. Such as sending the message to server / write to file.
38+
To make the logic readable, it is important to make the operation's name meaningfully. It is developer's responsibility to make a good name. Also, the name also determine the degree of reusable of code.
39+
e.g. If you create an operation named: `SimplePrintOp`, it should contain only the code to print the message associated with it. You should NOT do anything out of the context of the name. Such as sending the message to server / write to file.
4040

4141
Also, all operations made for Flow should share a common suffix (e.g. Op) so all developers can know that there are operations that ready for reuse.
4242

@@ -263,7 +263,7 @@ You can trace the data changes, how the operations run in one place. You can sen
263263

264264
## Why not RxSwift?
265265
Surely RXsSwift is much more powerful in some aspects.
266-
BUT I think it's always good if we can make our codes: `Simple and Human readable`
266+
BUT I think it's always good if we can make our code: `Simple and Human readable`
267267
With `Flow`, even code reviewers and non-programmer can understand your logic in the blueprint.
268268

269269
## Requirements

0 commit comments

Comments
 (0)