From bdf7c12e2af9a8b81775ca3dcfa3c92a25bb97a9 Mon Sep 17 00:00:00 2001
From: Usman Baig <mubaig@pm.me>
Date: Fri, 23 Jan 2026 10:49:20 +0100
Subject: [PATCH] chore(docs): update README to reflect project name change
 from 'Pulse Frontend' to 'Pulse' and clarify description of the analytics
 platform

---
 CONTRIBUTING.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       |  4 ++--
 SECURITY.md     | 24 +++++++++++++++++++
 3 files changed, 88 insertions(+), 2 deletions(-)
 create mode 100644 CONTRIBUTING.md
 create mode 100644 SECURITY.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..7a6c821
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,62 @@
+# Contributing to Pulse
+
+Thank you for your interest in contributing to Pulse! We welcome contributions from the community to help make privacy-first analytics better for everyone.
+
+## Getting Started
+
+1.  **Fork the repository** on GitHub.
+2.  **Clone your fork** locally:
+    ```bash
+    git clone https://github.com/YOUR_USERNAME/pulse.git
+    cd pulse
+    ```
+3.  **Install dependencies**:
+    ```bash
+    npm install
+    ```
+4.  **Set up environment variables**:
+    Copy `.env.example` (if available) or create `.env.local` with the following:
+    ```env
+    NEXT_PUBLIC_API_URL=http://localhost:8082
+    NEXT_PUBLIC_AUTH_URL=http://localhost:3000
+    NEXT_PUBLIC_AUTH_API_URL=http://localhost:8081
+    NEXT_PUBLIC_APP_URL=http://localhost:3003
+    ```
+5.  **Run the development server**:
+    ```bash
+    npm run dev
+    ```
+
+## Development Workflow
+
+1.  Create a new branch for your feature or fix:
+    ```bash
+    git checkout -b feature/my-new-feature
+    ```
+2.  Make your changes.
+3.  **Lint and Type Check**:
+    Before committing, ensure your code passes our quality checks:
+    ```bash
+    npm run lint
+    npm run type-check
+    ```
+4.  Commit your changes with a descriptive message.
+5.  Push to your fork and submit a **Pull Request**.
+
+## Code Style
+
+-   We use **Next.js** with **TypeScript**.
+-   Styling is done with **Tailwind CSS**.
+-   Please follow the existing code style and conventions found in the project.
+-   Ensure all new components are responsive and support dark mode.
+
+## Pull Request Guidelines
+
+-   Provide a clear description of what your PR does.
+-   Link to any relevant issues.
+-   Ensure all checks pass (linting, type checking).
+-   If you are adding a new feature, please include screenshots or a video if applicable.
+
+## License
+
+By contributing to Pulse, you agree that your contributions will be licensed under the [AGPL-3.0 License](LICENSE).
diff --git a/README.md b/README.md
index a5d8333..0933158 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
-# Pulse Frontend
+# Pulse
 
 [![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-green.svg)](https://www.gnu.org/licenses/agpl-3.0)
 [![Built with Next.js](https://img.shields.io/badge/Built%20with-Next.js-blue.svg?logo=next.js&logoColor=white)](https://nextjs.org/)
 [![Hosted on Railway](https://img.shields.io/badge/Hosted%20on-Railway-orange.svg?logo=railway&logoColor=white)](https://railway.app/)
 
-Pulse Frontend is the dashboard interface for Pulse. It provides a simple, intuitive interface for managing sites and viewing analytics data.
+Pulse is the dashboard interface for the Pulse analytics platform. It provides a simple, intuitive interface for managing sites and viewing analytics data.
 
 ## Features
 
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 0000000..3734113
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,24 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.1.x   | :white_check_mark: |
+| < 0.1.0 | :x:                |
+
+## Reporting a Vulnerability
+
+We take the security of Pulse very seriously. If you discover a security vulnerability, please **DO NOT** open a public issue on GitHub.
+
+Instead, please report it responsibly by emailing us at:
+
+**security@ciphera.net**
+
+Please include the following details in your report:
+
+-   Description of the vulnerability.
+-   Steps to reproduce the issue.
+-   Potential impact.
+
+We will acknowledge your report within 48 hours and work with you to address the issue. We appreciate your help in making Pulse secure for everyone.