diff --git a/README.md b/README.md new file mode 100644 index 0000000..ce4c84b --- /dev/null +++ b/README.md @@ -0,0 +1,94 @@ + + +
+

YOUR REPOSITORY TITLE

+ +

+ A SHORT DESCRIPTION ABOUT THE PROJECT +
+
+ View Demo + · + Report Bug + · + Request Feature +

+
+ +## 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 + +* []() +* []() +* []()