Add supplimental resources

Cargo.toml

@@ -1,12 +1,17 @@
 [package]
 name = "rlviser-py"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
+description = "Python implementation that manages a UDP connection to RLViser"
+license = "MIT"
+repository = "https://github.com/VirxEC/rlviser-py"
+readme = "README.md"
+keywords = ["rlviser", "rocket-league", "udp", "python", "rlbot"]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [lib]
 name = "rlviser_py"
-crate-type = ["rlib", "cdylib"]
+crate-type = ["cdylib"]
 
 [dependencies]
 glam = "0.24.0"
@@ -16,5 +21,6 @@ pyo3 = "0.19.0"
 [profile.release]
 lto = true
 strip = true
+opt-level = "z"
 codegen-units = 1
 panic = "abort"

README.md

@@ -0,0 +1,9 @@
+## rlviser-py
+
+[![forthebadge](https://forthebadge.com/images/badges/made-with-rust.svg)](https://forthebadge.com)
+
+Python implementation that manages a UDP connection to RLViser, it launches the [RLViser binary](https://github.com/VirxEC/rlviser) from the current working directory upon first calling any render function.   
+
+Currently able to visualize RLGym GameState objects, but requires the boost pad locations to be sent first.
+
+The backbone of RLGym's `env.render()` functionality.

rlviser_py.pyi

@@ -0,0 +1,13 @@
+def set_boost_pad_locations(locations: list) -> ...:
+    pass
+
+try:
+    from rlgym_sim.utils.gamestates.game_state import GameState
+
+    def render_rlgym(gym_state: GameState) -> ...:
+        pass
+except ImportError:
+    pass
+
+def quit() -> ...:
+    pass

src/lib.rs

@@ -73,7 +73,7 @@ pub const OCTANE: CarConfig = CarConfig {
 
 /// Reads the RLGym state and sends it to RLViser to render
 #[pyfunction]
-fn render_rlgym(gym_state: GymState) -> PyResult<()> {
+fn render_rlgym(gym_state: GymState) {
     // construct the game state
     let game_state = GameState {
         tick_count: TICK_COUNT.fetch_add(1, Ordering::SeqCst),
@@ -125,8 +125,6 @@ fn render_rlgym(gym_state: GymState) -> PyResult<()> {
     };
 
     socket::send_game_state(&game_state).unwrap();
-
-    Ok(())
 }
 
 /// Send the quit signal to RLViser