Merge pull request #12 from Gimnath-Perera/doc/GitHub-readme-update

doc: github-readme updated

README.md

@@ -1 +1,78 @@
-# mocktopus
+<p align="center">
+  <img src="https://i.ibb.co/CK8DcHm/logo.png" alt="Project Logo" width="200">
+</p>
+
+# Mocktopus | TypeScript Interface Mock Data Generator
+
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/your-username/your-project-name/blob/main/LICENSE)
+[![Next.js Version](https://img.shields.io/badge/Next.js-13.0.0-blueviolet.svg)](https://nextjs.org/)
+[![TypeScript Version](https://img.shields.io/badge/TypeScript-4.5.2-blue.svg)](https://www.typescriptlang.org/)
+
+Generate mock data effortlessly from TypeScript interfaces in a web application powered by Next.js and NextUI.
+
+## Table of Contents
+
+- [Mocktopus | TypeScript Interface Mock Data Generator](#mocktopus--typescript-interface-mock-data-generator)
+  - [Table of Contents](#table-of-contents)
+  - [About](#about)
+  - [Features](#features)
+  - [Getting Started](#getting-started)
+  - [Contributing](#contributing)
+  - [License](#license)
+
+## About
+
+The TypeScript Interface Mock Data Generator is a user-friendly web application built with Next.js, NextUI, and TypeScript. It simplifies the process of generating mock data for TypeScript projects. Just provide one or more TypeScript interfaces, and the application will generate one or multiple rows of mock data for you.
+
+## Features
+
+- **TypeScript Interface-Based:** Input your TypeScript interfaces to generate data that matches your data structure.
+
+- **Multiple Data Types:** Supports a wide range of data types, including numbers, strings, dates, and custom types.
+
+- **Customization:** Fine-tune the generated data by specifying rules, formats, and constraints.
+
+- **Realistic Data:** Create realistic data by defining ranges, patterns, and dependencies.
+
+- **Preview:** Visualize and preview the generated data before exporting it.
+
+- **Export Data:** Export the generated mock data in various formats (JSON, CSV, etc.).
+
+- **Save Templates:** Save and reuse your interface templates for future use.
+
+- **Interactive Web Interface:** A sleek and user-friendly web application built with NextUI.
+
+- **MIT License:** Open-source and available for use in your projects.
+
+## Getting Started
+
+1. Clone this repository:
+
+` git clone https://github.com/your-username/your-project-name.git`
+
+2. Install dependencies:
+
+   `cd your-project-name`
+   `yarn install`
+
+3. Run dev server:
+   `yarn dev`
+
+4. Open your browser and visit http://localhost:3000.
+
+##Usage
+
+1. **Input TypeScript Interfaces**: Define your TypeScript interfaces in the application.
+2. **Configure Data Generation**: Set rules, constraints, and formats for each field.
+3. **Preview Data**: Visualize the generated mock data.
+4. **Export Data**: Download the generated data in various formats.
+
+## Contributing
+
+We welcome contributions from the community! To contribute to this project, please follow our Contributing Guidelines.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+_Made with ❤️ by [Gimnath Perera](https://github.com/Gimnath-Perera)_