From afe89e9343dc6eb056e2cae064f8ecd257a1bdba Mon Sep 17 00:00:00 2001
From: Valerian Saliou <valerian@valeriansaliou.name>
Date: Sun, 10 Nov 2024 14:45:49 +0100
Subject: [PATCH] chore: populate readme

---
 .gitignore | 36 +++++++++++++++++-------------------
 README.md  | 20 +++++++++++++++++---
 2 files changed, 34 insertions(+), 22 deletions(-)

diff --git a/.gitignore b/.gitignore
index a547bf3..90df954 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,24 +1,22 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-pnpm-debug.log*
-lerna-debug.log*
+# NPM
+npm-debug.log
+node_modules/
+.npm
 
-node_modules
+# Caches
+.cache
+.eslintcache
+
+# Builds
 dist
-dist-ssr
-*.local
 
-# Editor directories and files
-.vscode/*
-!.vscode/extensions.json
+# Configuration
+config/local.json
+
+# Editor
+.nova
 .idea
+.vscode
+
+# macOS
 .DS_Store
-*.suo
-*.ntvs*
-*.njsproj
-*.sln
-*.sw?
diff --git a/README.md b/README.md
index 1511959..5e11a17 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,19 @@
-# Vue 3 + Vite
+# prose-pod-dashboard
 
-This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+[![Test and Build](https://github.com/prose-im/prose-pod-dashboard/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/prose-im/prose-pod-dashboard/actions/workflows/test.yml)
 
-Learn more about IDE Support for Vue in the [Vue Docs Scaling up Guide](https://vuejs.org/guide/scaling-up/tooling.html#ide-support).
+**Prose Pod dashboard. Web interface used to administer a Prose Pod server.**
+
+Copyright 2024, Prose Foundation - Released under the [Mozilla Public License 2.0](./LICENSE.md).
+
+_Tested at NodeJS version: `v20.7.0`_
+
+## License
+
+Licensing information can be found in the [LICENSE.md](./LICENSE.md) document.
+
+## :fire: Report A Vulnerability
+
+If you find a vulnerability in any Prose system, you are more than welcome to report it directly to Prose Security by sending an encrypted email to [security@prose.org](mailto:security@prose.org). Do not report vulnerabilities in public GitHub issues, as they may be exploited by malicious people to target production systems running an unpatched version.
+
+**:warning: You must encrypt your email using Prose Security GPG public key: [:key:57A5B260.pub.asc](https://files.prose.org/public/keys/gpg/57A5B260.pub.asc).**