From c578aa766e5e2c543de3b6c73586e840e90aeee8 Mon Sep 17 00:00:00 2001 From: Georgios Kampitakis <50364739+gkampitakis@users.noreply.github.com> Date: Fri, 5 Jul 2024 18:47:20 +0100 Subject: [PATCH] chore(docs): document crlf limitation (#101) --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 0849192..01c2b87 100644 --- 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.