describe stignore fork at top of readme

2026-08-12 13:57:17 +02:00
parent 8a34a6373a
commit 73699efb57
2 changed files with 24 additions and 0 deletions
@@ -1,3 +1,11 @@
+# Syncthing with `.stignore` synchronization
+
+This fork synchronizes the root-level `.stignore` file as regular folder
+content, while keeping `.stfolder` and `.stversions` protected as Syncthing
+internals. The `upstream` branch mirrors the official Syncthing `main` branch;
+this fork's `main` branch and releases apply the `.stignore` synchronization
+patch.
+
 [![Syncthing][14]][15]

 ---
@@ -1,3 +1,19 @@
+diff --git a/README.md b/README.md
+index 2f5c18f8e..197150ff0 100644
+--- a/README.md
+++ b/README.md
+@@ -1,3 +1,11 @@
+# Syncthing with `.stignore` synchronization
+
+This fork synchronizes the root-level `.stignore` file as regular folder
+content, while keeping `.stfolder` and `.stversions` protected as Syncthing
+internals. The `upstream` branch mirrors the official Syncthing `main` branch;
+this fork's `main` branch and releases apply the `.stignore` synchronization
+patch.
+
+ [![Syncthing][14]][15]
+ 
+ ---
 diff --git a/lib/fs/filesystem.go b/lib/fs/filesystem.go
 index 3800bef9c..8e6ecea2e 100644
 --- a/lib/fs/filesystem.go