Skip to content

Commit e8bc840

Browse files
Update integration notes
Link to the sample hanami 2 todo app and deprecate dry-web-web_pipe. Also deprecate the rails sample application.
1 parent 4630014 commit e8bc840

File tree

4 files changed

+22
-30
lines changed

4 files changed

+22
-30
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,19 @@
33

44
# WebPipe
55

6-
`web_pipe` is a modular rack application builder through a pipe of
7-
operations on an immutable struct.
6+
`web_pipe` is a builder of composable rack applications through a pipe of
7+
functions on an immutable struct.
88

9-
To use in conjunction with [dry-rb](https://dry-rb.org/) ecosystem,
9+
> `web_pipe` plays incredibly well with `hanami 2`. If you want to create a
10+
> `hanami 2` app with `web_pipe`, you can take inspiration from this sample todo
11+
> application:
12+
>
13+
> https://github.com/waiting-for-dev/hanami_2_web_pipe_todo_app
14+
15+
To use in conjunction with [hanami](https://hanamirb.org/) [dry-rb](https://dry-rb.org/) ecosystem,
1016
see also
1117
[`dry-web-web_pipe`](https://github.com/waiting-for-dev/dry-web-web_pipe).
1218

13-
If you want to use it with a Rails project, don't miss docs for the [rails
14-
extension](docs/extensions/rails.md).
15-
1619
1. [Introduction](docs/introduction.md)
1720
1. [Design model](docs/design_model.md)
1821
1. [Building a rack application](docs/building_a_rack_application.md)
@@ -49,7 +52,7 @@ extension](docs/extensions/rails.md).
4952
1. [Session](docs/extensions/session.md)
5053
1. [URL](docs/extensions/url.md)
5154
1. Recipes
52-
1. [dry-rb integration](docs/recipes/dry_rb_integration.md)
55+
1. [hanami 2 & dry-rb integration](docs/recipes/hanami_2_and_dry_rb_integration.md)
5356
1. [hanami-router integration](docs/recipes/hanami_router_integration.md)
5457
1. [Using all RESTful methods](docs/recipes/using_all_restful_methods.md)
5558

docs/extensions/rails.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,3 @@ We have placed `WebPipe` applications within `app/controllers/` directory in
107107
all the examples. However, remember you can put them wherever you like as long
108108
as you respect rails
109109
[`autoload_paths`](https://guides.rubyonrails.org/autoloading_and_reloading_constants.html#autoload-paths).
110-
111-
Here you have a link to a straightforward and contrived example of a rails
112-
application integrating `web_pipe`:
113-
114-
https://github.com/waiting-for-dev/rails-web_pipe
115-

docs/recipes/dry_rb_integration.md

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Hanami 2 and dry-rb integration
2+
3+
`web_pipe` has been designed to integrate smoothly with
4+
the [hanami](https://hanamirb.org/) & [dry-rb](https://dry-rb.org/) ecosystems. It shares the same design
5+
principles, and it ships with some extensions that even make this
6+
integration painless (like [`:dry-schema`](../extensions/dry_schema.md)
7+
extension or [`:hanami_view`](../extensions/hanami_view.md)).
8+
9+
If you want to use `web_pipe` within a hanami 2 application, you can take
10+
inspiration from this sample todo app:
11+
12+
https://github.com/waiting-for-dev/hanami_2_web_pipe_todo_app

0 commit comments

Comments
 (0)