feat: init readme

CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing
+
+## How to Contribute
+
+### Reporting Issues
+
+If you find a bug or have a suggestion for improving the project,
+please start by checking if a similar issue already exists.
+If not, feel free to open a new issue with a clear description, including:
+
+- Steps to reproduce the issue.
+- Expected behavior.
+- Actual behavior.
+- Environment details (Go version, OS, etc.).
+
+### Submitting Pull Requests
+
+To contribute, please follow these steps:
+
+1. **Fork the Repository**: Click the 'Fork' button on the repository page to create your own copy of the repository.
+
+2. **Create a Branch**: Create a branch in your fork for your changes. It's best to name the branch something descriptive.
+
+3. **Make Your Changes**: Implement your changes, adhering to the coding standards and guidelines of the project.
+
+4. **Write Tests**: Ensure that your changes are covered by tests. We strive to maintain a high level of code quality and test coverage.
+
+5. **Run the Tests**: Before submitting your changes, make sure all tests pass.
+
+6. **Update Documentation**: If your changes involve user-facing features or interfaces, update the README or other relevant documentation.
+
+7. **Commit Your Changes**: Use clear and descriptive commit messages.
+
+8. **Submit a Pull Request**: Push your changes to your fork and open a pull request to the main repository. In the pull request description, explain your changes and reference any related issues.
+
+9. **Code Review**: Once your pull request is open, the maintainers will review your changes. Be open to feedback and making revisions if requested.
+
+### Code Review Process
+
+Maintainers will review your pull request. We aim for a prompt review, but response times can vary based on availability. During the review process, we may:
+
+- Provide feedback and request changes if necessary.
+- Merge your pull request once it is approved and all criteria are met.
+
+### Coding Standards
+
+- Follow [Effective Go](https://golang.org/doc/effective_go) guidelines.
+- Ensure code is formatted with `go fmt`.
+- Write idiomatic and readable Go code.
+- Add comments where necessary, especially for public functions and interfaces.

README.md

@@ -1 +1,48 @@
 # Drillerfy: Go Database Testing Simplified
+
+## Overview
+
+Drillerfy is a Go package designed to simplify database testing.
+It provides a streamlined approach for setting up and tearing down databases,
+making it easier to test Go applications that interact with databases.
+
+## Features
+
+- Easy setup and teardown of databases.
+- Easy migrations stairway tests.
+- Support for multiple database engines.
+
+## Installation
+
+```(bash)
+go get github.com/Alviner/drillerfy
+```
+
+## Usage
+
+### Database Module
+
+Provides functionality to easily create and drop databases.
+This is particularly useful in testing environments where you need to set up a fresh database instance for each test run and clean it up afterward.
+
+### Migrations Module
+
+Provides functionality to easily run stairway tests for migrations via goose Provider.
+This module simplifies the process of applying and reverting database schema changes,
+which is essential in maintaining consistent database states for testing.
+
+## Contributing
+
+Contributions to Drillerfy are welcome.
+Please read the contributing guidelines in the repository
+for instructions on how to submit pull requests, report issues, and suggest enhancements.
+
+## License
+
+Drillerfy is released under the MIT License.
+See the LICENSE file in the repository for full license text.
+
+## Authors
+
+Drillerfy was created and is maintained by [Alviner](https://github.com/Alviner).
+Contributions from the community are appreciated.