From b9f705c7b2f947ad4548e7483d38b1328e6d9556 Mon Sep 17 00:00:00 2001
From: Rekai Musuka <rekai@musuka.dev>
Date: Tue, 9 Feb 2021 15:02:27 -0600
Subject: [PATCH] Add README.md

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9c2ce13
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# Blue Archive Gacha Simulator 
+
+Here's an implementation of Blue Archive's Gacha System
+I believe it to be correct, though I'm always willing to accept corrections if you have any!
+
+
+## Example
+
+Here's what's needed in order to call `.roll()` and `.roll10()`.
+
+```rust
+let mut file = File::open("students.json").unwrap();
+    let mut json = String::new();
+    file.read_to_string(&mut json).unwrap();
+
+    let students: Vec<Student> = serde_json::from_str(&json).unwrap();
+
+    let banner_students: Vec<Student> = students
+        .iter()
+        .filter(|student| student.name != "ノゾミ")
+        .map(|student| student.clone())
+        .collect();
+
+    let hoshino = find_student(&students, "ホシノ").unwrap();
+    let shiroko = find_student(&students, "シロコ").unwrap();
+    let rate_up_students = vec![shiroko, hoshino];
+
+    let gacha = GachaBuilder::new(79.0, 18.5, 2.5)
+        .with_pool(banner_students)
+        .with_priority(&rate_up_students, 0.7)
+        .finish()
+        .unwrap();
+
+    let pickup_banner = BannerBuilder::new("ピックアップ募集")
+        .with_name_translation(Language::English, "Rate-Up Registration")
+        .with_sparkable_students(&rate_up_students)
+        .with_gacha(&gacha)
+        .finish()
+        .unwrap();
+```
\ No newline at end of file