chore(docs): document crlf limitation (#101)

gkampitakis · Jul 5, 2024 · c578aa7 · c578aa7
1 parent f98a2f9
commit c578aa7
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -353,3 +353,6 @@ This library used [Jest Snapshoting](https://jestjs.io/docs/snapshot-testing) an
 
 > [!IMPORTANT]
 > Snapshots should be treated as code. The snapshot artifact should be committed alongside code changes, and reviewed as part of your code review process
+
+> [!NOTE]
+> go-snaps doesn't handle CRLF line endings. If you are using Windows, you may need to convert the line endings to LF.