Skip to content

Commit

Permalink
style(docs): improve visibility of KPI
Browse files Browse the repository at this point in the history
  • Loading branch information
Lerri-Cofannos committed Oct 17, 2023
1 parent ffeec55 commit 093a70c
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,13 @@

# Overview

[![GitHub last commit](https://img.shields.io/github/last-commit/Theodo-UK/OmniLog)](https://github.com/Theodo-UK/OmniLog/commits)
[![Downloads](https://static.pepy.tech/badge/omnilogger)](https://www.pepy.tech/projects/omnilogger)

Omnilog allows you to easily monitor your LLM project!

1. Simply run our initialisation script on your AWS account
2. Start our listener in our python project,
2. Start our listener in your python project,
3. View your logs and analytics in your privately deployed web app!

![image](https://github.com/Theodo-UK/OmniLog/assets/57725347/a494d81d-dab1-4836-8922-efec380c5812)
Expand Down Expand Up @@ -75,6 +78,9 @@ If you want to remove the AWS resources, then you simply have to call this scrip
# Help us by contributing

[![Build Status](https://github.com/Theodo-UK/OmniLog/workflows/app-cd/badge.svg)](https://github.com/Theodo-UK/OmniLog/actions)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/YourUsername/YourRepo)

We welcome contributions from the community to help improve OmniLog. You can contribute in the following ways:

Contribute to the Web App by setting up a development environment as outlined in the [Dev-setup](/front/README.md) guide.
Expand Down

0 comments on commit 093a70c

Please sign in to comment.