Update README (#6)

* Update README

* Make description a one-liner

README.md

@@ -1,47 +1,61 @@
-# cache-artifacts
+# julia-actions/cache Action
-A shortcut action to cache Julia artifacts.
 
-Using this action is equivalent to including the following step in your workflows:
+A shortcut action to cache Julia artifacts, packages and (optionally) registries to reduce GitHub Actions running time.
-
-```yaml
-- uses: actions/cache@v1
-  env:
-    cache-name: cache-artifacts
-  with:
-    path: ~/.julia/artifacts
-      key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
-      restore-keys: |
-        ${{ runner.os }}-test-${{ env.cache-name }}-
-```
 
 ## Usage
 
-### Inputs
+An example workflow that uses this action might look like this:
 
 ```yaml
-- uses: julia-actions/cache-artifacts@v1
+name: CI
-  with:
+
-    # The cache name is used as part of the cache key.
+on: [push, pull_request]
-    # It is equivalent to the cache-name environment variable in the snippet above.
+
-    #
+jobs:
-    # Default: cache-artifacts
+  test:
-    cache-name: ''
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: julia-actions/setup-julia@v1
+    - uses: julia-actions/cache@v1
+    - uses: julia-actions/julia-buildpkg@v1
+    - uses: julia-actions/julia-runtest@v1
 ```
 
+By default, this caches the files in `~/.julia/artifacts/` and `~/.julia/packages/`.
+To also cache `~/.julia/registries/`, use
+
+```yaml
+    - uses: julia-actions/cache@v1
+      with:
+        cache-registries: "true"
+```
+
+Note that caching the registries may actually slow down the workflow running time on Windows runners.
+That is why caching the registries is disabled by default.
+
+### Inputs
+
+- `cache-name` - Name used as part of the cache keys
+- `cache-artifacts` - Whether to cache `~/.julia/artifacts/`. Enabled by default.
+- `cache-packages` - Whether to cache `~/.julia/packages/`. Enabled by default.
+- `cache-registries` - Whether to cache `~/.julia/registries/`. Disabled by default.
+
 ### Outputs
 
-```yaml
+- `cache-hit` - A boolean value to indicate an exact match was found for the primary key. Returns \"\" when the key is new. Forwarded from actions/cache.
-outputs:
+
-  # A boolean value to indicate an exact match was found for the primary key.
+## How it works
-  # Forwarded from actions/cache, check its documentation for more info.
+
-  cache-hit: ''
+This action is a wrapper around <https://github.com/actions/cache>.
-```
+In summary, this action stores the files in the aforementioned paths in one compressed file when running for the first time.
+This cached file is then restored upon the second run.
+The benefit of this is that downloading one big file is more quick than downloading many different files from many different locations.
 
 ## Third Party Notice
 
 This action is built around [`actions/cache`](https://github.com/actions/cache/) and includes parts of that action. `actions/cache` has been released under the following licence:
 
-
 > The MIT License (MIT)
 >
 > Copyright (c) 2018 GitHub, Inc. and contributors