Umami is a privacy-first web and product analytics platform. Traffic, campaigns, behavior, conversions, and revenue in one place. No cookies, no surveillance, self-hosted or in the cloud.
TypeScript analyticsaudience-segmentationchartscohort-analysisgoogle-analyticsproduct-analyticsstatisticsuser-journeyweb-analytics
Update README.md
SHUBHAM SHARMA51f7e187b730
diff --git a/README.md b/README.mdindex 6d9755d4d..9ca0bf8a7 100644--- a/README.md+++ b/README.md@@ -1,49 +1,56 @@-# 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.+# Umami-## Getting started+> Umami is a simple, fast, privacy-focused alternative to Google Analytics.++[![GitHub Release][release-shield]][releases-url]+[![MIT License][license-shield]][license-url]+[![Build Status][build-shield]][build-url]++## Getting StartedA detailed getting started guide can be found at [https://umami.is/docs/](https://umami.is/docs/)-## Installing from source+## 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-```+```bashnpm install -g yarn```-### Get the source code and install packages+### Get the Source Code and Install Packages-```+```bashgit clone https://github.com/umami-software/umami.gitcd umamiyarn install```-### Configure umami+### Configure Umami-Create an `.env` file with the following+Create an `.env` file with the following:-```+```bashDATABASE_URL=connection-url```-The connection url is in the following format:+The connection URL is in the following format:-```+```bashpostgresql://username:mypassword@localhost:5432/mydb-mysql://username:mypassword@localhost:3306/mydb```-### Build the application+### Build the Application```bashyarn build@@ -51,19 +58,17 @@ yarn buildThe 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**.-### Start the application+### Start the Application```bashyarn 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.## Installing with Docker-To build the umami container and start up a Postgres database, run:+To build the Umami container and start up a Postgres database, run:```bashdocker compose up -d@@ -81,7 +86,7 @@ Or with MySQL support:docker pull docker.umami.is/umami-software/umami:mysql-latest```-## Getting updates+## Getting UpdatesTo get the latest features, simply do a pull, install any new dependencies, and rebuild:@@ -102,3 +107,9 @@ docker compose up --force-recreateMIT+[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