Skip to content

Commit a41321b

Browse files
committed
Better document stability
1 parent 722df83 commit a41321b

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ N.B. Litterbox is free software that does not come with any warranty or guarante
1818

1919
## Introductory presentation
2020

21-
[![Litterbox Presentation](https://img.youtube.com/vi/OMCWs7qmKFc/0.jpg)](https://www.youtube.com/watch?v=OMCWs7qmKFc)
21+
For those who like videos, the following presentation provides a quick overview of Litterbox:
22+
23+
[![Litterbox Presentation](https://img.youtube.com/vi/OMCWs7qmKFc/maxresdefault.jpg)](https://www.youtube.com/watch?v=OMCWs7qmKFc)
2224

2325
## Isolation limitations
2426

@@ -117,6 +119,8 @@ Litterbox is most similar to Distrobox in terms of its design and functionality.
117119

118120
Litterbox is still early in its development lifecycle and not particularly stable yet. Litterbox does not follow proper "semver" yet since we want to reserve 1.0.0 to signify a decent level of stability. Currently, (in the context of a version specified as `x.y.z`), changes in `y` will indicate breaking changes. It is therefore important to keep track of release notes for breaking changes when updating as you might have to make changes to your Litterbox definitions and rebuild them.
119121

122+
Also keep in mind that the `main` branch might be broken from time to time because proper automated testing is not in place yet. Hence, it is recommended to also check out a tagged release if you want something that works. The releases are not guaranateed to be 100% working either, but more effort it made to test them.
123+
120124
## TODO
121125

122126
Litterbox is still very much WIP with many missing features or required improvements. Following is a list of some important pieces that are still missing:

0 commit comments

Comments
 (0)