[Automatic Validation] Create README.md

README.md

@@ -0,0 +1,94 @@
+<!--
+    This template file is used and was generated by Repository Validator.
+    If you use this file as a template for your own README, you may
+    remove this comment.
+-->
+
+<div align="center">
+  <h2 align="center">YOUR REPOSITORY TITLE</h2>
+
+  <p align="center">
+    A SHORT DESCRIPTION ABOUT THE PROJECT
+    <br />
+    <br />
+    <a href="https://github.com/by-pinja/repo">View Demo</a>
+    ·
+    <a href="https://github.com/by-pinja/repo/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/by-pinja/repo/issues">Request Feature</a>
+  </p>
+</div>
+
+## Table of Contents
+
+* [About the Project](#about-the-project)
+  * [Built With](#built-with)
+* [Getting Started](#getting-started)
+  * [Prerequisites](#prerequisites)
+  * [Installation](#installation)
+* [Usage](#usage)
+* [Roadmap](#roadmap)
+* [Contributing](#contributing)
+* [License](#license)
+* [Contact](#contact)
+* [Acknowledgements](#acknowledgements)
+
+## About The Project
+
+Here's a blank template to get started:
+**To avoid retyping too much info. Do a search and replace with your text editor for the following:**
+`repo`, `email`
+
+### Built With
+
+* []()
+* []()
+* []()
+
+## Getting Started
+
+To get a local copy up and running follow these simple steps.
+
+### Prerequisites
+
+This is an example of how to list things you need to use the software and how to install them.
+* Docker - [see documentation](https://docs.docker.com/install/)
+
+### Installation
+
+1. Clone the repo
+```sh
+git clone https://github.com/by-pinja/repo.git
+```
+2. Start with Docker Compose
+```sh
+docker-compose up -d
+```
+
+## Usage
+
+Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
+
+_For more examples, please refer to the [Documentation](https://example.com)_
+
+## Roadmap
+
+See the [open issues](https://github.com/by-pinja/repo/issues) for a list of proposed features (and known issues).
+
+## Contributing
+
+[See steps for contributing](./CONTRIBUTING.md).
+
+## License
+
+[See license for details](./LICENSE).
+
+## Contact
+
+Your Name - firstname.lastname@pinja.com
+
+## Acknowledgements
+
+* []()
+* []()
+* []()