Skip to content

Commit d246cec

Browse files
committed
update README
1 parent d7141e6 commit d246cec

File tree

1 file changed

+27
-83
lines changed

1 file changed

+27
-83
lines changed

README.md

Lines changed: 27 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,69 @@
1-
<p align="center">
2-
<img src="https://umami.is/images/umami-logo.png" alt="Umami Logo" width="100">
3-
</p>
1+
# Website analytics
42

5-
<h1 align="center">Umami</h1>
3+
We are using [Umami](https://github.com/umami-software/umami), a simple, fast, privacy-focused alternative to Google Analytics for our website tracking.
64

7-
<p align="center">
8-
<i>Umami is a simple, fast, privacy-focused alternative to Google Analytics.</i>
9-
</p>
5+
## Getting started
106

11-
<p align="center">
12-
<a href="https://github.com/umami-software/umami/releases">
13-
<img src="https://img.shields.io/github/release/umami-software/umami.svg" alt="GitHub Release" />
14-
</a>
15-
<a href="https://github.com/umami-software/umami/blob/master/LICENSE">
16-
<img src="https://img.shields.io/github/license/umami-software/umami.svg" alt="MIT License" />
17-
</a>
18-
<a href="https://github.com/umami-software/umami/actions">
19-
<img src="https://img.shields.io/github/actions/workflow/status/umami-software/umami/ci.yml" alt="Build Status" />
20-
</a>
21-
<a href="https://analytics.umami.is/share/LGazGOecbDtaIwDr/umami.is" style="text-decoration: none;">
22-
<img src="https://img.shields.io/badge/Try%20Demo%20Now-Click%20Here-brightgreen" alt="Umami Demo" />
23-
</a>
24-
</p>
7+
A detailed getting started guide can be found at [https://umami.is/docs/](https://umami.is/docs/)
258

26-
---
27-
28-
## 🚀 Getting Started
29-
30-
A detailed getting started guide can be found at [umami.is/docs](https://umami.is/docs/).
31-
32-
---
33-
34-
## 🛠 Installing from Source
9+
## Installing from source
3510

3611
### Requirements
3712

3813
- A server with Node.js version 16.13 or newer
39-
- A database. Umami supports [MySQL](https://www.mysql.com/) (minimum v8.0) and [PostgreSQL](https://www.postgresql.org/) (minimum v12.14) databases.
14+
- A database. Umami supports [MySQL](https://www.mysql.com/) (minimum v8.0) and [Postgresql](https://www.postgresql.org/) (minimum v12.14) databases.
4015

4116
### Install Yarn
4217

43-
```bash
18+
```
4419
npm install -g yarn
4520
```
4621

47-
### Get the Source Code and Install Packages
22+
### Get the source code and install packages
4823

49-
```bash
24+
```
5025
git clone https://github.com/umami-software/umami.git
5126
cd umami
5227
yarn install
5328
```
5429

55-
### Configure Umami
30+
### Configure umami
5631

57-
Create an `.env` file with the following:
32+
Create an `.env` file with the following
5833

59-
```bash
34+
```
6035
DATABASE_URL=connection-url
6136
```
6237

63-
The connection URL format:
38+
The connection url is in the following format:
6439

65-
```bash
40+
```
6641
postgresql://username:mypassword@localhost:5432/mydb
42+
6743
mysql://username:mypassword@localhost:3306/mydb
6844
```
6945

70-
### Build the Application
46+
### Build the application
7147

7248
```bash
7349
yarn build
7450
```
7551

76-
*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**.*
52+
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**.
7753

78-
### Start the Application
54+
### Start the application
7955

8056
```bash
8157
yarn start
8258
```
8359

84-
*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.*
85-
86-
---
60+
By default this will launch the application on `http://localhost:3000`. You will need to either
61+
[proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server
62+
or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly.
8763

88-
## 🐳 Installing with Docker
64+
## Installing with Docker
8965

90-
To build the Umami container and start up a Postgres database, run:
66+
To build the umami container and start up a Postgres database, run:
9167

9268
```bash
9369
docker compose up -d
@@ -105,9 +81,7 @@ Or with MySQL support:
10581
docker pull docker.umami.is/umami-software/umami:mysql-latest
10682
```
10783

108-
---
109-
110-
## 🔄 Getting Updates
84+
## Getting updates
11185

11286
To get the latest features, simply do a pull, install any new dependencies, and rebuild:
11387

@@ -124,36 +98,6 @@ docker compose pull
12498
docker compose up --force-recreate
12599
```
126100

127-
---
128-
129-
## 🛟 Support
130-
131-
<p align="center">
132-
<a href="https://github.com/umami-software/umami">
133-
<img src="https://img.shields.io/badge/GitHub--blue?style=social&logo=github" alt="GitHub" />
134-
</a>
135-
<a href="https://twitter.com/umami_software">
136-
<img src="https://img.shields.io/badge/Twitter--blue?style=social&logo=twitter" alt="Twitter" />
137-
</a>
138-
<a href="https://linkedin.com/company/umami-software">
139-
<img src="https://img.shields.io/badge/LinkedIn--blue?style=social&logo=linkedin" alt="LinkedIn" />
140-
</a>
141-
<a href="https://umami.is/discord">
142-
<img src="https://img.shields.io/badge/Discord--blue?style=social&logo=discord" alt="Discord" />
143-
</a>
144-
</p>
145-
146-
[release-shield]: https://img.shields.io/github/release/umami-software/umami.svg
147-
[releases-url]: https://github.com/umami-software/umami/releases
148-
[license-shield]: https://img.shields.io/github/license/umami-software/umami.svg
149-
[license-url]: https://github.com/umami-software/umami/blob/master/LICENSE
150-
[build-shield]: https://img.shields.io/github/actions/workflow/status/umami-software/umami/ci.yml
151-
[build-url]: https://github.com/umami-software/umami/actions
152-
[github-shield]: https://img.shields.io/badge/GitHub--blue?style=social&logo=github
153-
[github-url]: https://github.com/umami-software/umami
154-
[twitter-shield]: https://img.shields.io/badge/Twitter--blue?style=social&logo=twitter
155-
[twitter-url]: https://twitter.com/umami_software
156-
[linkedin-shield]: https://img.shields.io/badge/LinkedIn--blue?style=social&logo=linkedin
157-
[linkedin-url]: https://linkedin.com/company/umami-software
158-
[discord-shield]: https://img.shields.io/badge/Discord--blue?style=social&logo=discord
159-
[discord-url]: https://discord.com/invite/4dz4zcXYrQ
101+
## License
102+
103+
MIT

0 commit comments

Comments
 (0)