Merge pull request #11 from Bardin08/vbardin/create-readme

Create README.md

README.md

@@ -0,0 +1,39 @@
+<img src="https://github.com/Bardin08/db-seeder/assets/67170413/7d90d3f8-c9cc-4747-a37b-2dddf49f1778" width="150px"/>
+
+# DB Seeder
+
+DB Seeder is a utility designed to streamline the process of populating databases with meaningful test data. This tool simplifies the task of generating and inserting test data into SQL databases.
+
+## Key Features
+
+- **Speed**: Easily obtain a populated database with meaningful data and all necessary relationships.
+- **Convenience**: No need to manually write data generation scripts.
+- **Scalability**: Generate any amount of records, from tens to millions.
+
+## How it Works
+
+DB Seeder takes an SQL script as input, responsible for creating tables, and fills the database with test data according to that schema. This allows developers and testers to quickly set up databases for testing purposes without the hassle of writing complex data generation scripts.
+
+## Installation
+
+TBA
+
+## Usage
+
+TBA
+
+## Example
+
+Suppose you have an SQL script `schema.sql` defining tables `users`, `products`, and their relationships. Running DB Seeder with this script will populate your database with sample data for these tables.
+
+## Contributions
+
+Contributions are welcome! Feel free to submit pull requests or open issues if you encounter any problems or have suggestions for improvements.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+
+*Made with ❤️ by Vladyslav Bardin*