Skip to content

Commit b51e91f

Browse files
committed
Update README.md
1 parent 5d86e39 commit b51e91f

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# action-docker-layer-caching [![Readme Test](https://github.com/satackey/action-docker-layer-caching/workflows/Readme%20Test/badge.svg)](https://github.com/satackey/action-docker-layer-caching/actions?query=workflow%3A%22Readme+Test%22) [![CI](https://github.com/satackey/action-docker-layer-caching/workflows/CI/badge.svg)](https://github.com/satackey/action-docker-layer-caching/actions?query=workflow%3ACI)
1+
# action-docker-layer-caching [![Readme Test status is unavailable](https://github.com/satackey/action-docker-layer-caching/workflows/Readme%20Test/badge.svg)](https://github.com/satackey/action-docker-layer-caching/actions?query=workflow%3A%22Readme+Test%22) [![CI status is unavailable](https://github.com/satackey/action-docker-layer-caching/workflows/CI/badge.svg)](https://github.com/satackey/action-docker-layer-caching/actions?query=workflow%3ACI)
22

33
Enable Docker Layer Caching by adding only one line.
44

@@ -17,12 +17,19 @@ jobs:
1717
steps:
1818
- uses: actions/checkout@v2
1919

20-
# Avoid caching pull-only images.(docker pull is faster than caching in most cases.)
20+
# Pull the latest image to build, and avoid caching pull-only images.
21+
# (docker pull is faster than caching in most cases.)
2122
- run: docker-compose pull
2223

23-
# Images created after this action is called are cached.
24+
# In this step, this action saves a list of existing images,
25+
# the cache is created without them in the post run.
26+
# It also restores the cache if it exists.
2427
- uses: satackey/action-docker-layer-caching@v0.0
28+
2529
- run: docker-compose build
30+
31+
# Finally, "Post Run satackey/action-docker-layer-caching@v0.0",
32+
# which is the process of saving the cache, will be executed.
2633
```
2734

2835
---

0 commit comments

Comments
 (0)