README

README.md

@@ -1,2 +1,46 @@
 # remote-desktop
 Golang Remote Desktop
+
+[![forthebadge](https://forthebadge.com/images/badges/made-with-go.svg)](https://forthebadge.com)
+
+## About:
+- A **simple** and **fast** remote-desktop service written in **golang**
+
+## Installation:
+### Requirements:
+- Laptop or Pc Running **macOS, Linux, Windows** with Pre-Installed **golang** with **git**
+
+### Building:
+- first step clone this [repo](https://github.com/krishpranav/remote-desktop)
+- download the required dependencies needed for the project via ```go mod tidy```
+- bulid the project by running this command ```make```
+
+## Contribution:
+- remote-desktop is an open-source project contributions are always welcomed
+- author [krishpranav](https://github.com/krishpranav)
+
+## License:
+- remote-desktop is licensed under [MIT-LICENSE](https://github.com/krishpranav/remote-desktop/blob/main/LICENSE)
+```
+MIT License
+
+Copyright (c) 2023 Krisna Pranav
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```