From 807efe898849c56a2b1a1314269eb17b36a38285 Mon Sep 17 00:00:00 2001
From: funlennysub <26184007+funlennysub@users.noreply.github.com>
Date: Sun, 16 Oct 2022 23:57:16 +0300
Subject: [PATCH] Reorganize files a bit; Add READMEs to all crate

---
 bepinex_helpers/README.md                                | 2 ++
 bepinex_installer/README.md                              | 9 +++++++++
 bepinex_installer/src/installer.rs                       | 4 +---
 bepinex_installer/src/main.rs                            | 2 +-
 bepinex_sources/README.md                                | 8 ++++++++
 bepinex_sources/examples/basic.rs                        | 2 +-
 .../src/{models/bleeding_edge => }/bepinex.rs            | 0
 bepinex_sources/src/lib.rs                               | 1 +
 bepinex_sources/src/models/bleeding_edge/mod.rs          | 1 -
 9 files changed, 23 insertions(+), 6 deletions(-)
 create mode 100644 bepinex_helpers/README.md
 create mode 100644 bepinex_installer/README.md
 create mode 100644 bepinex_sources/README.md
 rename bepinex_sources/src/{models/bleeding_edge => }/bepinex.rs (100%)

diff --git a/bepinex_helpers/README.md b/bepinex_helpers/README.md
new file mode 100644
index 0000000..de7037b
--- /dev/null
+++ b/bepinex_helpers/README.md
@@ -0,0 +1,2 @@
+# bepinex_helpers
+Different structs and function meant to be used by other tools in a repo
\ No newline at end of file
diff --git a/bepinex_installer/README.md b/bepinex_installer/README.md
new file mode 100644
index 0000000..8a7a97e
--- /dev/null
+++ b/bepinex_installer/README.md
@@ -0,0 +1,9 @@
+# BepInEx Installer
+
+## Features
+| Name                     | Description             | Status |
+| ------------------------ | ----------------------- | :----: |
+| Stable Releases          | Install stable releases |   ✔    |
+| BE Releases              | Install BE releases     |   ❌    |
+| Better UI                | Make UI look pretty     |   👷‍♀️    |
+| Support other game types | Support for .NET games  |   ❌    |
diff --git a/bepinex_installer/src/installer.rs b/bepinex_installer/src/installer.rs
index be862e2..e516db8 100644
--- a/bepinex_installer/src/installer.rs
+++ b/bepinex_installer/src/installer.rs
@@ -1,9 +1,7 @@
 use std::time::Duration;
 
 use bepinex_helpers::game::{Game, GameType};
-use bepinex_sources::models::bleeding_edge::bepinex::{
-    AssetDownloader, BepInEx, BepInExRelease, ReleaseFlavor,
-};
+use bepinex_sources::bepinex::{AssetDownloader, BepInEx, BepInExRelease, ReleaseFlavor};
 use eframe::{
     egui::{
         Button, CentralPanel, ComboBox, Direction, FontFamily::Proportional, FontId, RichText,
diff --git a/bepinex_installer/src/main.rs b/bepinex_installer/src/main.rs
index 5d9d584..21cf397 100644
--- a/bepinex_installer/src/main.rs
+++ b/bepinex_installer/src/main.rs
@@ -4,8 +4,8 @@ pub mod installer;
 
 use bepinex_helpers::game::get_unity_games;
 use bepinex_sources::{
+    bepinex::{BepInEx, BepInExRelease},
     github::GitHubApi,
-    models::bleeding_edge::bepinex::{BepInEx, BepInExRelease},
 };
 use eframe::{egui, run_native, NativeOptions};
 use lazy_static::lazy_static;
diff --git a/bepinex_sources/README.md b/bepinex_sources/README.md
new file mode 100644
index 0000000..d83a4c6
--- /dev/null
+++ b/bepinex_sources/README.md
@@ -0,0 +1,8 @@
+# bepinex_sources
+Crate for working with different BepInEx sources such as [Bleeding edge builds](https://builds.bepinex.dev/projects/bepinex_be) and [Stable builds](https://github.com/BepInEx/BepInEx/releases)
+
+## Features
+| Source             | Access all releases | Download specific release | Filter out releases | SourceRelease type into general type |
+| ------------------ | :-----------------: | ------------------------- | ------------------- | ------------------------------------ |
+| github.com         |          ✔          | ✔                         | ✔                   | ✔                                    |
+| builds.bepinex.dev |          ❌          | ❌                         | ❌                   | ❌                                    |
\ No newline at end of file
diff --git a/bepinex_sources/examples/basic.rs b/bepinex_sources/examples/basic.rs
index 293c5dc..0b7d315 100644
--- a/bepinex_sources/examples/basic.rs
+++ b/bepinex_sources/examples/basic.rs
@@ -1,4 +1,4 @@
-use bepinex_sources::{github::GitHubApi, models::bleeding_edge::bepinex::BepInExRelease};
+use bepinex_sources::{bepinex::BepInExRelease, github::GitHubApi};
 use semver::Version;
 
 fn main() -> anyhow::Result<()> {
diff --git a/bepinex_sources/src/models/bleeding_edge/bepinex.rs b/bepinex_sources/src/bepinex.rs
similarity index 100%
rename from bepinex_sources/src/models/bleeding_edge/bepinex.rs
rename to bepinex_sources/src/bepinex.rs
diff --git a/bepinex_sources/src/lib.rs b/bepinex_sources/src/lib.rs
index 123c56c..a2d082f 100644
--- a/bepinex_sources/src/lib.rs
+++ b/bepinex_sources/src/lib.rs
@@ -1,2 +1,3 @@
+pub mod bepinex;
 pub mod github;
 pub mod models;
diff --git a/bepinex_sources/src/models/bleeding_edge/mod.rs b/bepinex_sources/src/models/bleeding_edge/mod.rs
index 7c1f291..e69de29 100644
--- a/bepinex_sources/src/models/bleeding_edge/mod.rs
+++ b/bepinex_sources/src/models/bleeding_edge/mod.rs
@@ -1 +0,0 @@
-pub mod bepinex;