diff --git a/README.md b/README.md index eb30f77..445fa55 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,37 @@ -# spotter-vector -🤖 This cute and little robot seems to be watching you +# Spotter Vector + +[![Build Status](https://img.shields.io/travis/OhMyVector/spotter-vector/main.svg?style=flat-square)](https://travis-ci.org/OhMyVector/spotter-vector) +[![Quality Gate Status](https://img.shields.io/sonar/quality_gate/OhMyVector_spotter-vector?server=https%3A%2F%2Fsonarcloud.io&style=flat-square)](https://sonarcloud.io/dashboard?id=OhMyVector_spotter-vector) + +## Project Description + +Spotter Vector is a powerful open-source tool designed for watching you. It leverages Golang to provide remote control. + +### Manual Setup + + + +### Docker Setup + +To spin up the server using Docker, follow these steps: + +1. Build the Docker image: + + ```bash + docker build -t spotter-vector . + ``` + +2. Run the Docker container: + + ```bash + docker run -p 8080:8080 spotter-vector + ``` + + + + + + + + +