Merge pull request #10 from tiktok/octogonz/alpha-disclaimer

Add README.md disclaimers

README.md

@@ -1,6 +1,13 @@
 
 <img width="380" src="./common/assets/sparo-380.png" alt="Sparo" />
 
+> 🚧 UNDER CONSTRUCTION 🚧
+>
+> This project is still under development.
+> It is not yet ready for general usage.
+> If you have questions or feedback, let us know
+> using [GitHub discussions](https://github.com/tiktok/sparo/discussions).
+
 ## Monorepo for Sparo toolkit
 
 <!-- Text below this line should stay in sync with the website index.md -->
@@ -28,7 +35,7 @@ For details, consult the [Sparo documentation](./apps/sparo/README.md).
 <!-- GENERATED PROJECT SUMMARY START -->
 
 ## Packages
- 
+
 <!-- the table below was generated using the ./repo-scripts/repo-toolbox script -->
 
 | Folder | Description |

apps/sparo-lib/README.md

@@ -1,5 +1,12 @@
 ## sparo-lib
 
+> 🚧 UNDER CONSTRUCTION 🚧
+>
+> This is an early test release of the software.
+> It is not yet ready for general usage.
+> If you have questions about this project, let us know
+> using [GitHub discussions](https://github.com/tiktok/sparo/discussions).
+
 This is a companion package for the Sparo tool. See the
 [sparo](https://npmjs.com/package/sparo) package for details.
 

apps/sparo/README.md

@@ -2,6 +2,13 @@
 
 <img width="380" src="../../common/assets/sparo-380.png" alt="Sparo" />
 
+> 🚧 UNDER CONSTRUCTION 🚧
+>
+> This is an early test release of the software.
+> It is not yet ready for general usage.
+> If you have questions about this project, let us know
+> using [GitHub discussions](https://github.com/tiktok/sparo/discussions).
+
 ## Is Git too slow in your frontend monorepo?
 
 By default `git clone` will download every file in your Git repository, as well as the complete history of every file. For small repositories, that's no big deal. But as your monorepo accumulates projects and years of history, Git operations become slower and slower, until one day `git status` is taking 10 seconds or more. What to do?
@@ -20,7 +27,7 @@ However, achieving good performance in a large repository requires more complex
 
 - **Git worktrees** allow multiple working directories on your computer to share a single `.git` folder, avoiding the cost of multiple clones. However this feature comes with awkward limitations, for example the same branch can't be checked out in two worktrees, and Git hooks are also shared.
 
-- **Sparse checkout** allows `git checkout` to extract a subset of files instead of the entire directory structure. Combined with partial clone, sparse checkout is the "battle axe" of Git optimization: although irrelevant projects and history will accumulate, your wait time will be proportional to the files you actually need. 
+- **Sparse checkout** allows `git checkout` to extract a subset of files instead of the entire directory structure. Combined with partial clone, sparse checkout is the "battle axe" of Git optimization: although irrelevant projects and history will accumulate, your wait time will be proportional to the files you actually need.
 
 ## How does Sparo help?
 

common/changes/sparo/octogonz-alpha-disclaimer_2024-02-22-00-53.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "sparo",
+      "comment": "Update documentation",
+      "type": "none"
+    }
+  ],
+  "packageName": "sparo"
+}