From 57cf75126953bbfef1dd3187378c750dfa52002e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fran=C3=A7ois=20Lorne?= <francois.lorne@hotmail.com>
Date: Tue, 17 Oct 2023 17:37:48 +0100
Subject: [PATCH] style(docs): format titles and images

---
 README.md       |  8 ++++----
 front/README.md | 17 ++++++++++-------
 2 files changed, 14 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index c6ac20b3..24c76372 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,8 @@
 
 ## Understand your LLM prompts, Empowered by Generative AI
 
-<div align="center">
-    <img src="./images/logo.png" alt="LLM-Ops-logo" width="50%"  style="border-radius: 50%; padding-bottom: 20px"/>
+<div align="center" style="background-color: white; border-radius: 150px; margin: 0 25% 20px 25%">
+    <img src="./images/logo.png" alt="LLM-Ops-logo" height="300" style="border-radius: 50px"/>
 </div>
 
 # Overview
@@ -32,7 +32,7 @@ Get started with OmniLog in five easy steps:
 - We recommend [Neon](https://neon.tech/) for an simple setup with a very generous free tier. You will need the connection string later (This can be found on the homepage after creating your Neon project) e.g:
 
 <div align="center">
-    <img src="./images/connection_details.avif" alt="LLM-Ops-logo" width="100%"/>
+    <img src="./images/connection_details.avif" alt="neon-connection-details" width="100%" style="max-width: 700px"/>
 </div>
 
 3. Third, clone our repository:
@@ -51,7 +51,7 @@ bash ./init.sh
 
 6. Run the `init.sh` script again, and skip the configuring of the .env files to deploy your web app properly.
 
-7. Use the Python SDK inside your LLM project:
+7. Use the [Python SDK](https://pypi.org/project/omnilogger/) inside your LLM project:
 
 ```python
 from omnilogger import start_openai_listener
diff --git a/front/README.md b/front/README.md
index 46f74975..da1463ec 100644
--- a/front/README.md
+++ b/front/README.md
@@ -1,12 +1,12 @@
 This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
 
-## Getting Started
+# Getting Started
 
 This project uses [sst](https://docs.sst.dev/what-is-sst), so we're using the SST local development flow [described here](https://docs.sst.dev/live-lambda-development).
 
 These steps are for devs who want to contribute to Omnilog, if you want to use Omnilog, follow the instructions [here](https://github.com/Theodo-UK/OmniLog#quickstart).
 
-### 1. Get Next.js app running locally
+## 1. Get Next.js app running locally
 
 If you are developing the website without the external resources, e.g using dummy data and don't want to setup the AWS stack, use this option.
 
@@ -15,21 +15,23 @@ If you are developing the website without the external resources, e.g using dumm
 
 If you click the localhost URL in the console, you should see the Next.js app running. If you are on a route which relies on external resources, you will encounter errors because it is not hooked up to your AWS lambdas; follow the next steps to get that set up!
 
-### 2. Set up local AWS credentials
+## 2. Set up local AWS credentials
 
 Having AWS credentials on your local machine is required to use SST.
 
 You can see the [steps required to add AWS credentials here.](/docs/aws_setup.md)
 
-### 3. Add database URI to .env
+## 3. Add database URI to .env
 
 Create the following env files:
+
 ```
 // .env (used for yarn seed)
 DATABASE_URL=<your_database_uri>?pgbouncer=true
 NEXTAUTH_SECRET=secret
 NEXTAUTH_URL=http://localhost:3000
 ```
+
 ```
 // .env.development (used for yarn sst dev)
 AWS_PROFILE_NAME=<your_aws_profile_name>
@@ -38,6 +40,7 @@ DATABASE_URL=<your_database_uri>?pgbouncer=true
 NEXTAUTH_SECRET=secret
 NEXTAUTH_URL=http://localhost:3000
 ```
+
 ```
 // .env.production (used for yarn sst deploy)
 AWS_PROFILE_NAME=<your_aws_profile_name>
@@ -49,7 +52,7 @@ NEXTAUTH_URL=<>
 
 Note that `?pgbouncer=true` is required at the end of DATABASE_URL ([see issue](https://github.com/prisma/prisma/issues/11643#issuecomment-1034078942)):
 
-### 4. Build Next.js app into Lambdas and deploy them locally
+## 4. Build Next.js app into Lambdas and deploy them locally
 
 -   `yarn dev_sst` to start the Live Lambda Development environment.
     -   This command does the following:
@@ -57,13 +60,13 @@ Note that `?pgbouncer=true` is required at the end of DATABASE_URL ([see issue](
         -   Builds the Next.js app into lambda functions,
         -   and deploys them to the local Lambda environment
 
-### 6. Bind Next.js app to local Lambda environment so that it can invoke AWS resources
+## 6. Bind Next.js app to local Lambda environment so that it can invoke AWS resources
 
 -   `yarn dev` to bind the Next.js app to sst, which allows it to invoke AWS resources.
     -   This command does the following:
         -   Starts the Next.js app at localhost
         -   Binds the Next.js app to the local Lambda environment (therefore allowing it to use AWS resources)
 
-## Deploying to staging
+# Deploying to staging
 
 -   `yarn deploy`