readme-updated

README.md

@@ -1,45 +1,54 @@
-# AuthFusion: Merging Spheron Compute with Tableland Databse for Authentication
+# Merging Spheron Compute with Tableland Database for Authentication
 
-AuthFusion is an innovative solution that integrates Tableland's robust authentication system with the computational power of Spheron. By doing so, it offers a seamless user experience, ensuring security and performance are at the forefront.
+**An integration of Spheron's computational power with Tableland's secure on-chain authentication, offering an enhanced level of security combined with efficient performance.**
 
-## Table of Contents
+## Description
 
-- [Introduction](#introduction)
-- [Features](#features)
-- [Use Cases](#use-cases)
-- [Getting Started](#getting-started)
-- [License](#license)
-- [Contributing](#contributing)
+AuthFusion represents a fusion of two distinct technologies, Spheron's computation capabilities and Tableland's secure on-chain authentication. This unique blend ensures not only a high level of security for user data but also offers a seamless and efficient user experience. In an era where security and performance cannot be compromised, AuthFusion emerges as a beacon of innovation.
 
-## Introduction
+## Why did we build this?
 
-In today's world, ensuring user data's security and privacy while providing a fast and efficient user experience is paramount. AuthFusion achieves this by utilizing Tableland's authentication combined with Superon's computational capabilities. This project is a testament to the power of integrating distinct technologies to create a harmonized solution.
+In the modern digital landscape, ensuring the security and privacy of user data is paramount. With an increasing number of cyber threats, there's a pressing need for robust authentication systems. By integrating Tableland's on-chain authentication with the computational prowess of Spheron, we've created a solution that ensures user data's utmost security while delivering fast and efficient performance. AuthFusion serves as a testament to what can be achieved when two powerful technologies converge.
 
-## Features
+## Usage:
 
-- **Tableland Integration**: Utilizes Tableland for storing user data securely and efficiently on-chain.
-- **Authentication**: Provides a robust authentication system ensuring user data's security.
-- **Superon Compute**: Leverages Superon's computational capabilities for fast and efficient back-end operations.
-- **Seamless User Experience**: A user-friendly interface that ensures a smooth sign-up and login process.
+1. Clone this repository: `git clone https://github.com/spheronFdn/spheron-notification-service.git`
+2. Run `npm install` to install dependencies.
+3. Create a `.env` file in the backend directory and Add the following:
 
-## Use Cases
+```bash
+#RPC url endpoint which will be used to fetch data from blockchain
+RPC_URL=
 
-1. **High-security Requirement Applications**: Any application where security is paramount can benefit from the robust authentication provided by Tableland.
-2. **Compute-intensive Operations**: Applications requiring significant back-end computations can leverage Superon's capabilities.
-3. **Scalable Applications**: Designed for scalability, making it suitable for applications expecting a significant number of users.
-4. **Rapid Development**: For projects that require quick deployment without compromising on security and performance.
+#The private key for the wallet which handles the data entries into the table
+PRIVATE_KEY=
+```
 
-## Getting Started
+4. If you don't already have a Spheron account, [create one here](https://spheron.link).
+5. Visit [Spheron Compute docs](https://docs.spheron.network/server-guide/express/) and follow all the steps from [STEP 3](#usage).
+6. Attach a Domain/Subdomain to your instance, and you're set!
 
-- Clone the repository: `git clone <repository_link>`
-- Navigate to the project directory: `cd AuthFusion`
-- Install required dependencies: `npm install`
-- Start the development server: `npm start`
+## Route definitions:
 
-## License
+- `/`: Registering a user to the database.
+- `/login`: Logging in a user.
 
-This project is licensed under the MIT License. See [LICENSE](LICENSE) for more details.
+## How it works?
 
-## Contributing
+Upon arrival, a new user can register, creating an entry in the Tableland tables database. The table, which receives the data, operates using the wallet defined by the PrivateKey in the `.env` file. This wallet facilitates data entry for new users and aids in reading data from the table during login. Furthermore, the Tableland database offers interoperability, allowing user database migration across different applications.
 
-Contributions are always welcome! If you have any suggestions, feature requests, or bugs to report, please open an issue. We appreciate any feedback and are constantly looking to improve.
+## Help
+
+For assistance, discussions, or any other inquiries: [Join our Community](https://discord.com/invite/ahxuCtm).
+
+## Version History:
+
+- **0.1**: Initial Release
+
+## License:
+
+This project is licensed under the MIT License. For more details, see the [LICENSE](LICENSE) file.
+
+## Acknowledgments:
+
+- [Spheron Documentation](https://docs.spheron.network/server-guide/express/)