Update README.md

winscripter · Oct 13, 2024 · e237add · e237add
1 parent 69cd4e6
commit e237add
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,15 @@
+> [!IMPORTANT]
+> This project is only a temporary solution to work with SLNX files before MSBuild supports SLNX files.
+> 
+> Currently, MSBuild does not support reading and manipulating SLNX files. However, as soon as it does, this
+> library may not be suitable anymore.
+>
+> However, MSBuild is actively getting new commits and PRs that put effort into supporting SLNX files. This is a good sign,
+> as we can finally begin building SLNX files in apps that support them. This, however, also means that the Slnx library will not
+> have much use when MSBuild begins to support SLNX files. Furthermore, the SLNX file format is not officially documented. Because of this,
+> the Slnx library may not be able to parse every single SLNX file, because the format is not officially documented.
+>
+
 # Slnx
 SLNX is a fast parser and writer for the (currently) new in-preview Visual Studio XML Solution format with a .slnx extension, introduced in Visual Studio 2022 17.10 Preview 3.