Added some documentation and added the README file to Cargo.toml

Author: Max Larsson

Cargo.toml

@@ -5,8 +5,9 @@ authors = ["Max Larsson <[email protected]>"]
 edition = "2018"
 description = "A rust implementation of the python 'input' function."
 repository = "https://github.com/maxslarsson/python-input"
-keywords = ["pytohn", "user", "input", "rust", "implementation"]
-license = "MIT"
+keywords = ["python", "user", "input", "rust", "implementation"]
+license = "MIT License"
+readme = "README.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

src/lib.rs

@@ -1,7 +1,17 @@
 use std::io::{stdin, stdout, Write};
 
-pub fn input(input_string: &str) -> String {
-    print!("{}", input_string);
+/// Returns a String with what the user typed in response to the prompt.
+///
+/// # Arguments
+///
+/// * `prompt` - A &str that is printed to the console as a prompt for the user.
+///
+/// # Remarks
+///
+/// This is a convenience function that just shortens the amount of code that is
+/// necessary to recieve user input in response to a prompt, such as a question.
+pub fn input(prompt: &str) -> String {
+    print!("{}", prompt);
     let mut input = String::new();
 
     stdout().flush().expect("Failed to flush stdout!");