aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4e82703
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# magisk-fstab
+
+A magisk module to load custom fstab configs on startup.
+
+## Requirements
+
+- Magisk v20.4+
+- Kernel support for filesystems to be mounted
+
+## Installation
+
+Install the release zip in Magisk Manager.
+
+## Usage
+
+1. Adjust the main config in `${MODDIR}/config/main.conf` to your liking. `$MODDIR` is usually `/data/adb/modules/magisk-fstab`.
+2. Place your `fstab` entries in `${MODDIR}/config/fstab.conf`.
+3. Upon every restart, this module will try to perform the actions based on the `fstab` config.
+
+## References
+
+- [Magisk documentation](https://topjohnwu.github.io/Magisk/)
+- [fstab manual](https://man7.org/linux/man-pages/man5/fstab.5.html)