Add readmes for all published crates.

[generate-random.git] / lib / README.md

diff --git a/lib/README.md b/lib/README.md
new file mode 100644 (file)
index 0000000..c2458ae
--- /dev/null
+++ b/lib/README.md
@@ -0,0 +1,29 @@
+# Generate-Random
+
+Generate random data.
+
+## Example
+
+```rust
+use generate_random::GenerateRandom;
+
+#[derive(GenerateRandom)]
+enum MyEnum {
+    A,
+    C(bool),
+    B {
+        x: u8,
+    },
+    // Providing a weight allows changing the probabilities.
+    // This variant is now twice as likely to be generated as the others.
+    #[weight(2)]
+    D,
+}
+
+let mut rng = rand::thread_rng();
+let my_value = MyEnum::generate_random(&mut rng);
+```
+
+## Documentation
+
+[Documentation](https://lib.rs/crates/generate-random)