Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Improve formatting of the notes in README.md

Close #93
  • Loading branch information
andreabedini authored Mar 18, 2024
1 parent 197ea64 commit b49b660
Showing 1 changed file with 18 additions and 15 deletions.
33 changes: 18 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,12 @@ github = { repo = "Company-XYZ/packageA", rev = "e76fdc753e660dfa615af6c8b6a2ad9
url = "https://hackage.haskell.org/package/shake-0.19.6/shake-0.19.6.tar.gz"
```

:information_source: Although the `timestamp` field in the package source metadata is
optional, it is highly recommended if you intend your repository users to
be able to use cabal's `index-state` functionality. Adding a timestamp
every time you add a package version ensures the newly created index is
"compatible" with what the users have already fetched.
> [!IMPORTANT]
> Although the `timestamp` field in the package source metadata is
> optional, it is highly recommended if you intend your repository users to
> be able to use cabal's `index-state` functionality. Adding a timestamp
> every time you add a package version ensures the newly created index is
> "compatible" with what the users have already fetched.
# Quickstart

Expand Down Expand Up @@ -149,11 +150,12 @@ subdir = "typed-protocols"
timestamp = 2022-03-29T06:19:50+00:00
```
:information_source: Foliage uses the metadata timestamps to determine the
order of the entries in `01-index`. This allows you to create an index that
can be updated incrementally and can be used with cabal's
[index-state](https://cabal.readthedocs.io/en/3.6/cabal-project.html?highlight=index-state#cfg-field-index-state)
feature.
> [!NOTE]
> Foliage uses the metadata timestamps to determine the
> order of the entries in `01-index`. This allows you to create an index that
> can be updated incrementally and can be used with cabal's
> [index-state](https://cabal.readthedocs.io/en/3.6/cabal-project.html?highlight=index-state#cfg-field-index-state)
> feature.

With the input above foliage will produce the following:

Expand Down Expand Up @@ -231,8 +233,8 @@ $ mkdir _keys
$ echo "$KEYS" | base64 -d | tar xz -C _keys
```

:warning: These are private keys. Don't publish them along with your
repository!
> [!WARNING]
> These are private keys. Don't publish them along with your repository!
# Revisions
Expand Down Expand Up @@ -261,9 +263,10 @@ in the source tree.
Revisions are independent of patches, a patched cabal file will be subject
to revisions just like the original cabal file.

:warning: It is not possible to "apply a timestamp" to a patch. A patch
changes the content of the source distribution and the repository can only
provide one source distribution for a given package name and version.
> [!IMPORTANT]
> It is not possible to "apply a timestamp" to a patch. A patch changes the
> content of the source distribution and the repository can only
> provide one source distribution for a given package name and version.

# New package versions

Expand Down

0 comments on commit b49b660

Please sign in to comment.