diff --git a/.env b/.env.example
similarity index 100%
rename from .env
rename to .env.example
diff --git a/.github/assets/logo-dark.png b/.github/assets/logo-dark.png
new file mode 100644
index 00000000..3e40a3dc
Binary files /dev/null and b/.github/assets/logo-dark.png differ
diff --git a/.github/assets/logo-light.png b/.github/assets/logo-light.png
new file mode 100644
index 00000000..a93bcfd1
Binary files /dev/null and b/.github/assets/logo-light.png differ
diff --git a/.gitignore b/.gitignore
index d2b624fa..9e2519a4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -70,7 +70,9 @@ typings/
.yarn-integrity
# dotenv environment variables file
+.env
.env.*
+!.env.example
# parcel-bundler cache (https://parceljs.org/)
.cache
diff --git a/README.md b/README.md
index ff71a672..76dbb4a5 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,18 @@
-# Parcelvoy
-Engage your customers through effortless communication.
+
+
+
+Open Source Multi-Channel Marketing
+
+Engage your customers through effortless communication.
+
+
## Features
- 💬 **Cross Channel Messaging** Send data-driven emails, push notifications and text messages.
@@ -14,21 +27,22 @@ Engage your customers through effortless communication.
You can run Parcelvoy locally or in the cloud easily using Docker.
-To get up and running quickly to try things out, copy our latest `docker-compose.yaml` and `.env` file onto your machine and go!
+To get up and running quickly to try things out, copy our latest `docker-compose.yml` and `.env` file onto your machine and go!
```
mkdir parcelvoy && cd parcelvoy
-wget https://raw.githubusercontent.com/parcelvoy/parcelvoy/master/{.env,docker-compose.yaml}
+wget https://raw.githubusercontent.com/parcelvoy/parcelvoy/master/{.env.example,docker-compose.yml}
+mv .env.example .env
docker compose up -d # run the Docker container
```
-Login to the web app at http://localhost:3000 by entering the default credentials found in your .env file.
+Login to the web app at http://localhost:3000 by entering the default credentials found in the copied `.env` file.
```
AUTH_BASIC_USERNAME=parcelvoy
AUTH_BASIC_PASSWORD=password
```
-We would recommend changing these default credentials as well as your `APP_SECRET` before ever using Parcelvoy in production.
+**Note:** We would recommend changing these default credentials as well as your `APP_SECRET` before ever using Parcelvoy in production.
For full documentation on the platform and more information on deployment, check out our docs.