Skip to content

Commit 3dd9da3

Browse files
committed
chore: updated readme.md
1 parent 49e969c commit 3dd9da3

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

readme.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# pipeline-go [![](https://github.com/izniburak/pipeline-go/workflows/build/badge.svg)](https://github.com/izniburak/pipeline-go/actions) [![PkgGoDev](https://pkg.go.dev/badge/github.com/izniburak/pipeline-go)](https://pkg.go.dev/github.com/izniburak/pipeline-go)
22

3+
This package allows you to employ the Pipeline pattern in your processes, and it's built upon the Chain of Responsibility (CoR) design pattern.
4+
5+
CoR is a behavioral design pattern that processes given data through a series of handlers. When a request reaches the pipe class, it processes the data and then forwards it to the next handler. The principle behind this pattern is straightforward.
6+
7+
> In summary, the Pipeline is a design pattern tailored for managing sequential modifications to an object. Imagine it as an assembly line: each station represents a pipe, and by the end of the line, you're left with a transformed object.
38
49
## Install
510

@@ -9,5 +14,18 @@ go get github.com/izniburak/pipeline-go
914

1015
## Examples
1116

17+
18+
## Contributing
19+
20+
1. Fork the repo (https://github.com/izniburak/pipeline-go/fork)
21+
2. Create your feature branch (git checkout -b my-new-feature)
22+
3. Commit your changes (git commit -am 'Add some feature')
23+
4. Push to the branch (git push origin my-new-feature)
24+
5. Create a new Pull Request
25+
26+
## Contributors
27+
28+
- [izniburak](https://github.com/izniburak) İzni Burak Demirtaş - creator, maintainer
29+
1230
## License
13-
The MIT License (MIT) - see [`license.md`](https://github.com/izniburak/pipeline-go/blob/main/license.md) for more details
31+
The MIT License (MIT) - see [`license.md`](https://github.com/izniburak/pipeline-go/blob/main/license.md) for more details

0 commit comments

Comments
 (0)