diff --git a/README.md b/README.md index b71cc2b..bb94fc3 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@    |    Docker Notes    |    + Web UI +    |    Contributing

@@ -133,6 +135,17 @@ You can use the `docker-compose.yml` file from the repository and use this comma docker-compose run sherlock -o /opt/sherlock/results/text.txt user123 ``` +### Web UI +You can access the web UI by entering "sherlock-web" folder and running the command: + +``` +docker-compose up +``` + +The command will create an API in port 8000 and a web UI that can be acessed by your preffered web browser in port 3000. + +Keep in mind this web version has no user credentials or any kind of security check, thus it is not nearly production ready. + ## Contributing We would love to have you help us with the development of Sherlock. Each and every contribution is greatly valued!