From 9c532f26abb02f70b8f4b30c90e0eebcf6ab6e7f Mon Sep 17 00:00:00 2001
From: SHUBHAM SHARMA <96301987+shubhusion@users.noreply.github.com>
Date: Sat, 25 May 2024 20:07:21 +0530
Subject: [PATCH] Update README.md
---
README.md | 47 ++++++++++++++++++++++++++++++++++++-----------
1 file changed, 36 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 18c5635a..8e0df60b 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,25 @@
Empowering insights. Preserving privacy.
-[![GitHub Release][release-shield]][releases-url] [![MIT License][license-shield]][license-url] [![Build Status][build-shield]][build-url] ++ Umami is a simple, fast, privacy-focused alternative to Google Analytics. +
+ + --- @@ -16,13 +30,13 @@ Explore Umami's features by trying out our demo installation: 👉 [Umami Demo](https://demo.umami.is/) 👈 -Please note that the demo is provided for exploration purposes only and may not include the latest features or configurations. For a more accurate representation, consider installing Umami on your own server. +*Please note that the demo is provided for exploration purposes only and may not include the latest features or configurations. For a more accurate representation, consider installing Umami on your own server.* --- ## 🚀 Getting Started -A detailed getting started guide can be found at [https://umami.is/docs/](https://umami.is/docs/) +A detailed getting started guide can be found at [umami.is/docs](https://umami.is/docs/). --- @@ -55,7 +69,7 @@ Create an `.env` file with the following: DATABASE_URL=connection-url ``` -The connection URL is in the following format: +The connection URL format: ```bash postgresql://username:mypassword@localhost:5432/mydb @@ -68,7 +82,7 @@ mysql://username:mypassword@localhost:3306/mydb yarn build ``` -The build step will also create tables in your database if you are installing for the first time. It will also create a login user with username **admin** and password **umami**. +*The build step will create tables in your database if you are installing for the first time. It will also create a login user with username **admin** and password **umami**.* ### Start the Application @@ -76,7 +90,7 @@ The build step will also create tables in your database if you are installing fo yarn start ``` -By default, this will launch the application on `http://localhost:3000`. You will need to either [proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly. +*By default, this will launch the application on `http://localhost:3000`. You will need to either [proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly.* --- @@ -123,7 +137,20 @@ docker compose up --force-recreate ## 📞 Contact -[![GitHub][github-shield]][github-url] [![Twitter][twitter-shield]][twitter-url] [![LinkedIn][linkedin-shield]][linkedin-url] [![Discord][discord-shield]][discord-url] + [release-shield]: https://img.shields.io/github/release/umami-software/umami.svg [releases-url]: https://github.com/umami-software/umami/releases @@ -139,5 +166,3 @@ docker compose up --force-recreate [linkedin-url]: https://linkedin.com/company/umami-software [discord-shield]: https://img.shields.io/badge/Discord--blue?style=social&logo=discord [discord-url]: https://discord.com/invite/4dz4zcXYrQ - ----