From cb68ce75f2462a324816414792d072e122281dc4 Mon Sep 17 00:00:00 2001
From: marceline-cramer <cramermarceline@gmail.com>
Date: Sat, 20 Nov 2021 17:42:50 -0700
Subject: [PATCH] Add README notes

---
 README.md   | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 src/main.rs |  6 ++++
 2 files changed, 85 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d9ef3a7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,79 @@
+# High-level Goals
+
+- modrinth mod searching
+- modrinth mod installation
+- per-instance mod management
+- mod updating
+
+If modrinth supports it:
+- conflict resolution
+- dependency resolution
+
+# File Architecture
+
+```bash
+- .config/hopper/config.toml # Main config file
+- .local/share/multimc/instances/*/.minecraft/Hopfile.toml # Multimc
+- .minecraft/Hopfile.toml # Official launcher
+- .var/app/com.mojang.Minecraft/.minecraft/Hopfile.toml # Flatpak version
+- .cache/hopper/ # Mod cache
+|              - hopper.lock # Lock file
+|              - mod1.jar # Mods
+|              - mod2.jar
++------------- - ...
+```
+
+# Usage (Planned)
+
+Create `Hopfile.toml` in your instance directory:
+```
+hopper init
+```
+
+Add mods:
+```
+hopper add iris
+hopper add sodium
+hopper add phosphor
+```
+
+Check for mod updates:
+```
+hopper update
+```
+
+# Docs (Planned)
+
+## `hopper init`
+
+```
+hopper init < --dir=./path/to/instance >
+```
+
+Inits in current directory if `dir` is left out, otherwise inits in given dir.
+
+## `hopper update`
+
+```
+hopper update < --mc-version=1.17 >
+```
+
+Updates all installed mods of a specific version, or a version set in the config.
+
+## `hopper add`
+
+```
+$ hopper add xx
+3> xxxy
+  Description for xxxy
+2> xxyz
+  Description for xxyz
+1> xx
+  Description for xx
+:: Select a mod
+:: ...
+```
+
+## `hopper get`
+
+Just like `hopper add` but simply downloads a mod jar.
diff --git a/src/main.rs b/src/main.rs
index 771dca6..72bac17 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -29,6 +29,12 @@ struct Args {
     command: Command,
 }
 
+impl Args {
+    fn default_paths(&mut self) {
+
+    }
+}
+
 #[derive(Deserialize, Debug)]
 struct Upstream {
     /// Modrinth main server URL