Merge pull request #15 from itsyourap/itsyourap-readme-fix

Fix README and add LICENSE

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Sayan Biswas
+
+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,8 +1,12 @@
 # NumplexApp
 
-NumplexApp is an innovative application designed to provide numerical analysis and complex mathematical operations with an intuitive user interface. This application aims to simplify complex calculations and present results in an easy-to-understand manner.
+NumplexApp is an innovative application designed to provide information about numbers. It allows
+users to view properties of a number, such as whether it is prime, even, odd, etc. The application
+features a user-friendly interface that simplifies the process of entering a number and viewing its
+properties.
 
 ## Table of Contents
+
 - [Features](#features)
 - [Installation](#installation)
 - [Usage](#usage)
@@ -11,13 +15,17 @@ NumplexApp is an innovative application designed to provide numerical analysis a
 - [Contact](#contact)
 
 ## Features
+
 - **User-Friendly Interface:** Simplified UI for easy navigation and use.
-- **Complex Calculations:** Perform advanced numerical and mathematical operations.
-- **Result Visualization:** Graphical representation of results for better understanding.
-- **Cross-Platform:** Compatible with multiple operating systems.
+- **Number Properties:** View properties of a number, such as whether it is prime, even, odd, etc.
 
 ## Installation
-To get started with NumplexApp, follow these steps:
+
+To get started with NumplexApp, you can either download the latest release from
+the [Releases](https://github.com/Sbiswas001/NumplexApp/releases) page or build the application from
+source.
+
+Follow the steps below to build the application from source:
 
 1. **Clone the Repository:**
     ```bash
@@ -27,46 +35,41 @@ To get started with NumplexApp, follow these steps:
     ```bash
     cd NumplexApp
     ```
-3. **Install Dependencies:**
+3. **Build the application:**
     ```bash
-    npm install
-    ```
-4. **Run the Application:**
-    ```bash
-    npm start
+    ./gradlew assembleDebug
     ```
 
 ## Usage
-After installing, you can start the application and begin using its features. Here's a quick guide:
 
-1. **Launching the App:**
-   Run the application using the start command mentioned above.
-2. **Perform Calculations:**
-   Navigate through the menus to select the type of calculation you need.
-3. **View Results:**
-   Results will be displayed in both numerical and graphical formats.
+After installing, you can start the application and begin using its features. Here's a quick guide:
 
-For more detailed usage instructions, refer to the user manual provided in the `docs` directory.
+1. **Enter number to view properties:**
+   Enter a number in the input field and click the "Show Properties" button.
+2. **View Results:**
+   Results will be displayed.
 
 ## Contributing
-We welcome contributions from the community! If you have any improvements or suggestions, please follow these steps:
 
-1. Fork the repository.
-2. Create a new branch (`git checkout -b feature/YourFeature`).
-3. Commit your changes (`git commit -m 'Add some feature'`).
-4. Push to the branch (`git push origin feature/YourFeature`).
-5. Open a Pull Request.
+We welcome contributions from the community! If you have any improvements or suggestions, please
+follow these steps:
 
-Please make sure to update tests as appropriate.
+1. Fork the repository.
+2. Clone the forked repository to your local
+   machine (`git clone https://github.com/<your_username>/NumplexApp.git && cd NumplexApp` ).
+3. Create a new branch (`git checkout -b feature`).
+4. Make your changes.
+5. Commit your changes (`git commit -m 'Add some feature'`).
+6. Push to the branch (`git push origin feature`).
+7. Open a Pull Request.
 
 ## License
+
 This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
 
 ## Contact
-For questions, suggestions, or feedback, please open an issue on GitHub or contact us at:
-- **Email:** sbiswas001@example.com
-- **GitHub:** [Sbiswas001](https://github.com/Sbiswas001)
 
----
+For questions, suggestions, or feedback, please open an issue on GitHub or contact us at:
 
-Feel free to enhance this README with more specific details about your project, such as screenshots, additional setup instructions, or more detailed usage examples.
+- **Email:** sbiswas001.tech@gmail.com
+- **GitHub:** [Sbiswas001](https://github.com/Sbiswas001)