Merge pull request #17 from bottlerocket-os/update-readme

chore: minimally populate README
bottlerocket-os · Oct 26, 2023 · 28bd991 · 28bd991
2 parents d516428 + fbe5725
commit 28bd991
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,6 +1,14 @@
 ## bottlerocket-settings-sdk
 
-TODO
+A Rust library for creating extensions to Bottlerocket's Settings API.
+
+For more information, see [the design document for modular Settings Extensions](https://github.com/bottlerocket-os/bottlerocket/blob/develop/docs/design/settings/extensions/modular-settings-extensions.md).
+
+## 🚧👷
+
+This project is currently being used in preliminary testing in the Bottlerocket repository, and is not ready for contributions.
+
+We welcome ideas and requirements in the form of issues and comments!
 
 ## Security