Skip to content

Commit 04cd67d

Browse files
authored
Update README.md (#97)
Improve formatting of the notes in README.md Close #93
1 parent 197ea64 commit 04cd67d

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,12 @@ github = { repo = "Company-XYZ/packageA", rev = "e76fdc753e660dfa615af6c8b6a2ad9
9090
url = "https://hackage.haskell.org/package/shake-0.19.6/shake-0.19.6.tar.gz"
9191
```
9292

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

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

158160
With the input above foliage will produce the following:
159161

@@ -231,8 +233,8 @@ $ mkdir _keys
231233
$ echo "$KEYS" | base64 -d | tar xz -C _keys
232234
```
233235

234-
:warning: These are private keys. Don't publish them along with your
235-
repository!
236+
> [!WARNING]
237+
> These are private keys. Don't publish them along with your repository!
236238
237239
# Revisions
238240
@@ -261,9 +263,10 @@ in the source tree.
261263
Revisions are independent of patches, a patched cabal file will be subject
262264
to revisions just like the original cabal file.
263265

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

268271
# New package versions
269272

0 commit comments

Comments
 (0)