Skip to content

Commit

Permalink
Update integration notes
Browse files Browse the repository at this point in the history
Link to the sample hanami 2 todo app and deprecate dry-web-web_pipe.
Also deprecate the rails sample application.
  • Loading branch information
waiting-for-dev committed Nov 7, 2021
1 parent 4630014 commit e8bc840
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 30 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,19 @@

# WebPipe

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

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

If you want to use it with a Rails project, don't miss docs for the [rails
extension](docs/extensions/rails.md).

1. [Introduction](docs/introduction.md)
1. [Design model](docs/design_model.md)
1. [Building a rack application](docs/building_a_rack_application.md)
Expand Down Expand Up @@ -49,7 +52,7 @@ extension](docs/extensions/rails.md).
1. [Session](docs/extensions/session.md)
1. [URL](docs/extensions/url.md)
1. Recipes
1. [dry-rb integration](docs/recipes/dry_rb_integration.md)
1. [hanami 2 & dry-rb integration](docs/recipes/hanami_2_and_dry_rb_integration.md)
1. [hanami-router integration](docs/recipes/hanami_router_integration.md)
1. [Using all RESTful methods](docs/recipes/using_all_restful_methods.md)

Expand Down
6 changes: 0 additions & 6 deletions docs/extensions/rails.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,9 +107,3 @@ We have placed `WebPipe` applications within `app/controllers/` directory in
all the examples. However, remember you can put them wherever you like as long
as you respect rails
[`autoload_paths`](https://guides.rubyonrails.org/autoloading_and_reloading_constants.html#autoload-paths).

Here you have a link to a straightforward and contrived example of a rails
application integrating `web_pipe`:

https://github.com/waiting-for-dev/rails-web_pipe

17 changes: 0 additions & 17 deletions docs/recipes/dry_rb_integration.md

This file was deleted.

12 changes: 12 additions & 0 deletions docs/recipes/hanami_2_and_dry_rb_integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Hanami 2 and dry-rb integration

`web_pipe` has been designed to integrate smoothly with
the [hanami](https://hanamirb.org/) & [dry-rb](https://dry-rb.org/) ecosystems. It shares the same design
principles, and it ships with some extensions that even make this
integration painless (like [`:dry-schema`](../extensions/dry_schema.md)
extension or [`:hanami_view`](../extensions/hanami_view.md)).

If you want to use `web_pipe` within a hanami 2 application, you can take
inspiration from this sample todo app:

https://github.com/waiting-for-dev/hanami_2_web_pipe_todo_app

0 comments on commit e8bc840

Please sign in to comment.