Merge remote-tracking branch 'origin/main'

Author: rcarver

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ryan Carver
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,6 +1,6 @@
 # SnapshotTestingEnvOverlay
 
-A drop-in replacement for swift-snapshot-testing that allows the snapshots directory
+A drop-in replacement for [swift-snapshot-testing](https://github.com/pointfreeco/swift-snapshot-testing) that allows the snapshots directory
 to be configured via ENV variable.
 
 This supports running on Xcode Cloud where tests don't have access to the file system,
@@ -11,6 +11,10 @@ with the exception of a `ci_scripts` directory. By symlinking your snapshots to
 SNAPSHOTTESTING_PACKAGES_PATH=/Volumes/workspace/respository/ci_scripts/snapshots
 ```
 
+Setting this ENV var means your snapshots are found in `ci_scripts/snapshots` instead of
+the standard location relative to the test file. By *not* setting this variable in 
+local development the normal snapshot location and workflow is untouched.
+
 ### Example Script
 
 This script will symlink all `__Snapshots__` directories into `ci_scripts/snapshots`,
@@ -36,3 +40,7 @@ find $search_path_from_snapshots -type d -name "__Snapshots__" | grep -v .build
     ln -s "$dir" "$parent_name"
 done
 ```
+
+## License 
+
+MIT