feat: readme

docs: oauth and device code added

Author: Eveeifyeve

README.md

@@ -1,2 +1,81 @@
-# rust
-The rust version of Minecraft essentials
+<!-- Minecraft-essentials - A Package that gives all Minecraft client essentials.
+ * Copyright (C) 2024 minecraft-essentials
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License v3.0
+ * along with this program.
+ -->
+
+
+
+
+
+# Minecraft Essentials
+
+A Package that gives all Minecraft client launchers essentials.
+
+## Features
+
+- Essential - functionality for Minecraft Client Launchers
+- Simplifies - Minecraft Client Launcher Building.
+- Fast - proforms better than other frameworks in authentification and launching
+- Safe - Forbids UnSafe code `#![forbid(unsafe_code)]`
+- Beginner Friendly - Full documentation and examples.
+
+## Templates
+
+All templates included in this package are free to use at any time. However, please note that copying the library code is subject to the terms of the GNU General Public License 3.0. For more details, refer to our [License](../LICENSE).
+
+## Notice
+
+**Some packages/libraries had to be split up into separate repositories. The list is provided below.**
+
+- [NPM (Node)](https://github.com/minecraft-essentials/npm)
+
+## Installation
+
+Prerequisites: 
+- Rust
+
+
+
+## Usage:
+
+### Oauth:
+```rust,ignore
+use minecraft_essentials::*;
+let client_id = "111231209837123098712";
+let oauth = Oauth::new(client_id);
+println!("Login here: {}", oauth.url());
+let oauth_info = oauth.launch().await?;
+```
+
+### Device_Code
+```rust,ignore
+use minecraft_essentials::*;
+let client_id = "111231209837123098712";
+let oauth = Oauth::new(client_id);
+println!("Login here: {}", oauth.url());
+
+let oauth_info = oauth.launch().await?;
+```
+
+
+**More usages comming soon.**
+
+
+
+
+## Licencing
+
+This library is licenced under the [GPL-3.0 Licence](./LICENSE)
+For the templates see the [README](./templates/README.md)