Merge pull request 'updated readme and added license' (#14) from staging into master

Reviewed-on: #14

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Freakoverse
+
+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.

README.md

@@ -1,11 +1,91 @@
-### Local testing
+[DEG Mods](https://degmods.com)
+===============================
 
-- clone the repo
+**DEG Mods** (Decentralized Game Mods) is a censorship-resistant platform for game mods, built on the Nostr protocol. It allows creators to thrive without the fear of censorship, bans, or losing their connection with fans. At DEG Mods, game mod creators and enthusiasts are empowered because, well, we literally can't mess with them.
 
-```sh
+Features
-npm ci
+--------
-```
 
-```sh
+-   **Never Get Your Game Mod Page Taken Down**: Enjoy peace of mind knowing that your content won't be removed or censored.
-npm run dev
+-   **Never Get Your Profile Banned**: Your profile remains active and accessible, without fear of bans.
-```
+-   **Never Lose Your Followers**: Maintain a steady connection with your followers and fans.
+-   **Get 100% of Tips Revenue**: Keep all the revenue from tips without any cuts.
+
+Installation
+------------
+
+To get started with DEG Mods, follow these steps:
+
+1.  **Clone the repository**:
+
+    bash
+
+    Copy code
+
+    `git clone <URL-of-repo>`
+
+2.  **Navigate to the project directory**:
+
+    bash
+
+    Copy code
+
+    `cd <project-directory>`
+
+3.  **Install dependencies**:
+
+    DEG Mods is a React project, so use `npm ci` to install the exact versions of dependencies as specified in `package-lock.json`:
+
+    bash
+
+    Copy code
+
+    `npm ci`
+
+Usage
+-----
+
+To run DEG Mods, follow these instructions:
+
+1.  **Start the development server**:
+
+    bash
+
+    Copy code
+
+    `npm run dev`
+
+Contributing
+------------
+
+We welcome contributions from the community! To contribute to DEG Mods:
+
+-   **Submit Issues**: Report bugs, provide feedback, or request features.
+-   **Submit Pull Requests**: Contribute code improvements or new features.
+
+Screenshots
+-----------
+
+Here are some screenshots of DEG Mods in action:
+
+-   ![Screenshot 1](https://image.nostr.build/9ea5f70a647581e5ea8855edcc2afb59b33195a3498c4052fa6350e414c03c50.jpg)
+-   ![Screenshot 2](https://image.nostr.build/f9a74d52547e84e51934f03358e5c41a2f99b896f1b2369fc3f4027d0f1a0d6f.jpg)
+-   ![Screenshot 3](https://image.nostr.build/cbd806c58a0f5e33b721cd9205c53aae64a422f271a8434b4d9bb8c3ba4e5c90.jpg)
+-   ![Screenshot 4](https://image.nostr.build/374bb4ca83211fd1f5646b611af188a424ebb1b44df1cb7ad29208868ac12675.jpg)
+
+Nostr Implementations
+---------------------
+
+-   ✅ **Text**
+-   ⬜ **Text**
+
+License
+-------
+
+This project is licensed under the MIT License. See the `LICENSE` file for more details.
+
+Acknowledgments
+----------------
+
+-   **Nostr Protocol**: Thanks to the Nostr community for the foundational technology that makes DEG Mods possible.
+-   **Contributors**: A shout-out to everyone who has contributed to making DEG Mods a reality.