From 6a06003a3827579c630f98f078fd2cf7df8088bb Mon Sep 17 00:00:00 2001 From: Ales Katona Date: Sun, 27 Jan 2019 21:45:19 -0700 Subject: [PATCH] add more docs and Cargo meta tags --- Cargo.toml | 2 ++ src/lib.rs | 6 ++++++ 2 files changed, 8 insertions(+) diff --git a/Cargo.toml b/Cargo.toml index 197f25c..997f04a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -9,6 +9,8 @@ repository = "https://gitlab.bitsmart.ltd/open/prongs.git" documentation = "https://doc.bitsmart.ltd/prongs" homepage = "https://gitlab.bitsmart.ltd/open/prongs" description = "Input handling schema written in rust. Backend agnostic, provides serializability, assignment and unified interface for working with inputs. Keyboard, mouse and controllers supported." +categories = ["game-engines", "config"] +keywords = ["input", "controller", "keyboard", "controls", "game"] [dependencies] bitflags = "1.0.4" diff --git a/src/lib.rs b/src/lib.rs index d927250..b835d51 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,9 @@ +//! Input handling schema written in rust. Backend agnostic, provides serializability, assignment and unified interface for working with inputs. Keyboard, mouse and controllers supported. +//! +//! Current backends include Piston and Gilrs with more on the way. +//! +//! **NOTE** prongs requires rust 1.32 or later + use serde::{Deserialize, Serialize}; use std::collections::HashMap;