Skip to content

Commit 91b68d9

Browse files
committed
fixup! [doc] Update ReadMe
1 parent c0cd77f commit 91b68d9

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,23 @@ pip install mfusepy
2424
You also need to install the `fuse` (2) or [`fuse3`](https://pkgs.org/search/?q=fuse3) package on your system.
2525

2626

27+
# Versioning
28+
29+
This version tries to follow [semantic versioning](https://semver.org/).
30+
If you depend on this project, you should fix the major version, or else you risk your project breaking on a newer version release!
31+
E.g., in your pyproject.toml:
32+
33+
```toml
34+
dependencies = ["mfusepy ~= 1.1",]
35+
```
36+
37+
If you have tested with multiple major versions and they are known to work, you can also relax the check for maximum compatibility:
38+
39+
```toml
40+
dependencies = ["mfusepy >= 1.1, < 3.0",]
41+
```
42+
43+
2744
# About this fork
2845

2946
This is a fork of [fusepy](https://github.com/fusepy/fusepy) because it did not see any development for over 6 years.
@@ -100,3 +117,9 @@ While FUSE is (at least in the Unix world) a [Kernel feature](https://man7.org/l
100117
- [WinFsp](https://github.com/billziss-gh/winfsp) (Windows) (fuse.h [2](https://github.com/winfsp/winfsp/blob/master/inc/fuse/fuse.h) [3](https://github.com/winfsp/winfsp/blob/master/inc/fuse3/fuse.h))
101118
- [Dokany](https://github.com/dokan-dev/dokany) (Windows) (fuse.h [2](https://github.com/dokan-dev/dokany/blob/master/dokan_fuse/include/fuse.h))
102119
- [Dokan](https://code.google.com/archive/p/dokan/) (Windows), no longer maintained
120+
121+
122+
# Known Dependants
123+
124+
- [Megatron-Energon](https://github.com/NVIDIA/Megatron-Energon)
125+
- [ninfs](https://github.com/ihaveamac/ninfs)

0 commit comments

Comments
 (0)