Skip to content

Commit 9fbd188

Browse files
committed
Chore(docs): update README
1 parent 9fe000b commit 9fbd188

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,39 @@
22

33
A buildpack static websites, aka for:
44

5-
* hugo
6-
* md-book
5+
* gohugo
6+
* mdBook
7+
8+
---
9+
10+
Here's a high-level overview about how this works:
11+
12+
```mermaid
13+
graph TD
14+
subgraph BUILD ["build phase"]
15+
direction LR
16+
version-->dl["download tool"]
17+
end
18+
19+
subgraph DETECT ["detect phase"]
20+
direction LR
21+
w["check work dir"]-->t["determine type"]
22+
end
23+
24+
DETECT-->d(("gohugo or mdBook"))
25+
d-->BUILD
26+
BUILD-->s["container with nginx/apache + your site"]
27+
```
728

829
Some configuration is available, please see [api](./api/) for details.
930

31+
## Dependencies
32+
33+
- `paketo-buildpacks/nginx`
34+
- `paketo-buildpacks/httpd`
35+
36+
Either of these can be customized through various environment variables or a full config file for the web server. More details are available [on our documentation](https://www.runway.horse/docs/recipes/webservers/).
37+
38+
## Usage / License
39+
1040
Feel free to use this, as you see fit. For the turn-key zero-config solution, please check out [our PaaS service Runway](https://www.runway.horse/).

0 commit comments

Comments
 (0)