Skip to content

Commit 327a612

Browse files
Update README.md - An initial version
1 parent 32ff8b6 commit 327a612

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
1-
This SDK is under development.
1+
### **This SDK is still under development & not ready for adoption yet.**
2+
3+
# Antithesis Rust SDK
4+
5+
This library provides methods for Rust programs to configure the [Antithesis](https://antithesis.com) platform. It contains three kinds of functionality:
6+
* Assertion macros that allow you to define test properties about your software or workload.
7+
* Randomness functions for requesting both structured and unstructured randomness from the Antithesis platform.
8+
* Lifecycle functions that inform the Antithesis environment that particular test phases or milestones have been reached.
9+
10+
For general usage guidance see the [Antithesis Rust SDK Documentation](https://antithesis.com/docs/using_antithesis/sdk/rust_sdk.html)
11+
12+
### Notes
213

314
When using llvm's link/loader from clang prior to version 16, it may be necessary to explicitly request
415
that unused sections are NOT removed from the resulting binary.

0 commit comments

Comments
 (0)