Added GitHub Releases support. See changelog

Author: theRookieCoder

CHANGELOG.md

@@ -2,6 +2,27 @@
 
 This changelog is formatted based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
+## [3.2.0] - 06.08.2021
+
+> A quick note about Octorok
+> 
+> Octorok is pretty buggy right now. AFAIK GitHub does not provide proper definitions for the structs used by their REST API, hence some fields which are supposed to be nullable may not be. _Please_ file an issue the moment you get an error about Octorok JSON deserialisation failing due to missing fields
+
+### Added
+
+- Added support for GitHub Releases
+- Added `Octorok`, a Github API abstraction for Ferium
+- Made the help page a 'copy' of the README file with suitable formatting
+- Added version command for checking the version
+- Added repositories to the configuration
+
+### Changed
+
+- Made HTTP calls non-blocking and asynchronous
+- Made all HTTP calls reuse a predefined client
+- Added more documentation
+- Made `make` builds timed
+
 ## [3.1.2] - 06.08.2021
 
 ### Added

Cargo.lock

@@ -1,13 +1,14 @@
 [package]
 name = "ferium"
-version = "3.1.2"
+version = "3.2.0"
 edition = "2018"
 authors = ["theRookieCoder"]
 
 [dependencies]
 reqwest = { version = "0.11", features = ["json", "blocking"] }
+tokio = { version = "1.11", features = ["full"] }
 serde = { version = "1", features = ["derive"] }
 clap = {version = "2", features = ["yaml"]}
+shellexpand = "2"
 serde_json = "1"
 bytes = "1"
-shellexpand = "2"

Cargo.toml

@@ -1,12 +1,13 @@
 # Ferium
 
-Ferium is an open source and easy to use package manager for Minecraft mods (that are on [Modrinth](https://modrinth.com)).
+Ferium is an open source and easy to use package manager for Minecraft mods (that are on [Modrinth](https://modrinth.com) and [Github](https://github.com/releases) Releases).
 
 ## Feature to do
 
 - [x] Allow configuration through a CLI
-- [ ] Add support for downloading from Github releases
+- [x] Add support for downloading from Github releases
 - [ ] Release the Labrinth library as a seperate Crate
+- [ ] Add support for checking mod loader compatibility
 - [ ] Check that the version is compatible with a specified Minecraft version
 - [ ] Add support for downloading from CurseForge
 
@@ -19,19 +20,29 @@ This section is the same as the one in `ferium help` + formatting.
 
 ### Commands
 - `list`
-  - List all the mods configured with some of their metadata
+  - Lists all the mods configured with some of their metadata
 - `help`
-  - Show this help page
+  - Shows this help page
 - `upgrade`
-  - Download and install the latest version of the mods specified
+  - Downloads and installs the latest version of the mods specified
 - `add MOD_ID`
-  - Add a mod to the config
+  - Adds a Modrinth mod to the config
   - A mod's `MOD_ID` is specified as '`</>` PROJECT ID' in the right sidebar of the mod's Modrith page
+- `add-repo OWNER REPO`
+  - Adds a repository to the config
+  - `OWNER` is username of the owner of the repository
+  - `REPO` is the name of the repository
 
 ### Examples
 ```bash
-$ ferium upgrade        # Upgrades all the mods in your config
-$ ferium add AANobbMI   # Adds the Sodium mod to your config
+# Upgrade all the mods in your config:
+$ ferium upgrade
+
+# Add the Sodium mod to your config:
+$ ferium add AANobbMI
+
+# Add the C2ME mod's repository to your config:
+$ ferium add-repo ishlandbukkit C2ME-fabric
 ```
 
 ### Error codes

README.md

@@ -1,20 +1,20 @@
 build-mac:
+	cargo clean
 	# For macOS arm
-	cargo build --target=aarch64-apple-darwin --release
+	time cargo build --target=aarch64-apple-darwin --release
 	# For macOS x86-64
-	cargo build --target=x86_64-apple-darwin --release
+	time cargo build --target=x86_64-apple-darwin --release
 
 build-win:
+	cargo clean
 	# For Windows x86-64
 	cargo build --target=x86_64-pc-windows-msvc --release
 	# For Windows on arm
 	cargo build --target=aarch64-pc-windows-msvc --release
 
 build-linux:
 	# For Linux x86-64
-	cargo build --target=x86_64-unknown-linux-gnu --release
+	cargo clean
+	time cargo build --target=x86_64-unknown-linux-gnu --release
 	# For Linux arm
-	cargo build --target=aarch64-unknown-linux-gnu --release
-
-run:
-	cargo run --release
+	time cargo build --target=aarch64-unknown-linux-gnu --release