Merge pull request #2756 from shubhusion/master

Enhance Readme.md

README.md

@@ -1,69 +1,95 @@
-# umami
+<p align="center">
+  <img src="https://github.com/shubhusion/umami/blob/master/src/assets/logo-white.svg" alt="Umami Logo" width="100">
+</p>
 
-Umami is a simple, fast, privacy-focused alternative to Google Analytics.
+<h1 align="center">Umami</h1>
 
-## Getting started
+<p align="center"><b>Empowering insights. Preserving privacy.</b></p>
 
-A detailed getting started guide can be found at [https://umami.is/docs/](https://umami.is/docs/)
+<p align="center">
+  <i>Umami is a simple, fast, privacy-focused alternative to Google Analytics.</i>
+</p>
 
-## Installing from source
+<p align="center">
+  <a href="https://github.com/umami-software/umami/releases">
+    <img src="https://img.shields.io/github/release/umami-software/umami.svg" alt="GitHub Release">
+  </a>
+  <a href="https://github.com/umami-software/umami/blob/master/LICENSE">
+    <img src="https://img.shields.io/github/license/umami-software/umami.svg" alt="MIT License">
+  </a>
+  <a href="https://github.com/umami-software/umami/actions">
+    <img src="https://img.shields.io/github/actions/workflow/status/umami-software/umami/ci.yml" alt="Build Status">
+  </a>
+  <a href="https://analytics.umami.is/share/LGazGOecbDtaIwDr/umami.is" style="text-decoration: none;">
+    <img src="https://img.shields.io/badge/Try%20Demo%20Now-Click%20Here-brightgreen" alt="Umami Demo">
+  </a>
+</p>
+
+---
+
+## 🚀 Getting Started
+
+A detailed getting started guide can be found at [umami.is/docs](https://umami.is/docs/).
+
+---
+
+## 🛠 Installing from Source
 
 ### Requirements
 
 - A server with Node.js version 16.13 or newer
-- A database. Umami supports [MySQL](https://www.mysql.com/) (minimum v8.0) and [Postgresql](https://www.postgresql.org/) (minimum v12.14) databases.
+- A database. Umami supports [MySQL](https://www.mysql.com/) (minimum v8.0) and [PostgreSQL](https://www.postgresql.org/) (minimum v12.14) databases.
 
 ### Install Yarn
 
-```
+```bash
 npm install -g yarn
 ```
 
-### Get the source code and install packages
+### Get the Source Code and Install Packages
 
-```
+```bash
 git clone https://github.com/umami-software/umami.git
 cd umami
 yarn install
 ```
 
-### Configure umami
+### Configure Umami
 
-Create an `.env` file with the following
+Create an `.env` file with the following:
 
-```
+```bash
 DATABASE_URL=connection-url
 ```
 
-The connection url is in the following format:
+The connection URL format:
 
-```
+```bash
 postgresql://username:mypassword@localhost:5432/mydb
-
 mysql://username:mypassword@localhost:3306/mydb
 ```
 
-### Build the application
+### Build the Application
 
 ```bash
 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
+### Start the Application
 
 ```bash
 yarn start
 ```
 
-By default this will launch the application on `http://localhost:3000`. You will need to either
+*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.*
-[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.
 
-## Installing with Docker
+---
 
-To build the umami container and start up a Postgres database, run:
+## 🐳 Installing with Docker
+
+To build the Umami container and start up a Postgres database, run:
 
 ```bash
 docker compose up -d
@@ -81,7 +107,9 @@ Or with MySQL support:
 docker pull docker.umami.is/umami-software/umami:mysql-latest
 ```
 
-## Getting updates
+---
+
+## 🔄 Getting Updates
 
 To get the latest features, simply do a pull, install any new dependencies, and rebuild:
 
@@ -98,7 +126,36 @@ docker compose pull
 docker compose up --force-recreate
 ```
 
-## License
+---
 
-MIT
+## 📞 Contact
 
+<p align="center">
+  <a href="https://github.com/umami-software/umami">
+    <img src="https://img.shields.io/badge/GitHub--blue?style=social&logo=github" alt="GitHub">
+  </a>
+  <a href="https://twitter.com/umami_software">
+    <img src="https://img.shields.io/badge/Twitter--blue?style=social&logo=twitter" alt="Twitter">
+  </a>
+  <a href="https://linkedin.com/company/umami-software">
+    <img src="https://img.shields.io/badge/LinkedIn--blue?style=social&logo=linkedin" alt="LinkedIn">
+  </a>
+  <a href="https://discord.com/invite/4dz4zcXYrQ">
+    <img src="https://img.shields.io/badge/Discord--blue?style=social&logo=discord" alt="Discord">
+  </a>
+</p>
+
+[release-shield]: https://img.shields.io/github/release/umami-software/umami.svg
+[releases-url]: https://github.com/umami-software/umami/releases
+[license-shield]: https://img.shields.io/github/license/umami-software/umami.svg
+[license-url]: https://github.com/umami-software/umami/blob/master/LICENSE
+[build-shield]: https://img.shields.io/github/actions/workflow/status/umami-software/umami/ci.yml
+[build-url]: https://github.com/umami-software/umami/actions
+[github-shield]: https://img.shields.io/badge/GitHub--blue?style=social&logo=github
+[github-url]: https://github.com/umami-software/umami
+[twitter-shield]: https://img.shields.io/badge/Twitter--blue?style=social&logo=twitter
+[twitter-url]: https://twitter.com/umami_software
+[linkedin-shield]: https://img.shields.io/badge/LinkedIn--blue?style=social&logo=linkedin
+[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

src/assets/logo-white.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 428 389.11">
+  <circle cx="214.15" cy="181" r="171" fill="none" stroke="white" stroke-miterlimit="10" stroke-width="20"/>
+  <path d="M413 134.11H15.29a15 15 0 0 0-15 15v15.3C.12 168 0 171.52 0 175.11c0 118.19 95.81 214 214 214 116.4 0 211.1-92.94 213.93-208.67 0-.44.07-.88.07-1.33v-30a15 15 0 0 0-15-15Z" fill="white"/>
+</svg>