From e078988f5cd10091779c22d363b348d325b78f61 Mon Sep 17 00:00:00 2001
From: Hadi <112569860+anotherhadi@users.noreply.github.com>
Date: Sat, 7 Mar 2026 17:52:29 +0100
Subject: [PATCH] Update doc
Signed-off-by: Hadi <112569860+anotherhadi@users.noreply.github.com>
---
README.md | 40 ++++++++++++++++++++++++++++++++--------
1 file changed, 32 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 6a91f77..fce8ad9 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,39 @@
-# Default Creds
+
+

+
+
+
+
+# Default-Creds
+
+
+
+
**Default Creds** is a centralized, community-driven repository of factory-set credentials. Designed for pentesters and security researchers, it helps identify weak access points during engagement phases or audit internal infrastructure before they become a security liability.
**Live Instance:** [default-creds.hadi.diy](https://default-creds.hadi.diy)
+
**API Documentation:** [default-creds.hadi.diy/api-docs](https://default-creds.hadi.diy/api-docs)
-## The Mission
+## 🎯 The Mission
In the world of cybersecurity, "low-hanging fruit" often comes in the form of unchanged default passwords. Our mission is to provide a fast, reliable, and searchable database of these credentials to help security professionals secure systems before attackers exploit them.
-## How it Works
+## ⚙️ How it Works
This application is built with **Astro** and **Svelte 5** for maximum performance. It operates as a "Flat-File Database":
@@ -17,7 +41,7 @@ This application is built with **Astro** and **Svelte 5** for maximum performanc
2. **Real-time Search:** The API parses these files on-the-fly (or via build cache) to provide instant results based on service names, versions, or tags.
3. **Developer Friendly:** A public API is available to integrate these credentials into your own automated scanning tools.
-## Community Driven & Contributing
+## 🤝 Community Driven & Contributing
Security is a collective effort. This project only grows as the community discovers and adds new default configurations.
@@ -26,11 +50,11 @@ Security is a collective effort. This project only grows as the community discov
Before contributing, please read our [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to format your YAML files.
-## Local Development
+## 💻 Local Development
### Prerequisites
-- Bun
+- Bun (or nix, just `nix develop`)
### Installation
@@ -51,12 +75,12 @@ bun dev
3. **Add your data:**
Drop a `.yaml` file into `src/data/` and it will appear in the search results instantly!
-## Tech Stack
+### 🛠️ Tech Stack
- **Framework:** [Astro](https://astro.build/)
- **UI Logic:** [Svelte 5 (Runes)](https://svelte.dev/)
- **Styling:** [Tailwind CSS](https://tailwindcss.com/) + [DaisyUI](https://daisyui.com/)
-## Legal Disclaimer
+## ⚠️ Legal Disclaimer
Usage of **Default Creds** for attacking targets without prior mutual consent is illegal. It is the end user's responsibility to obey all applicable local, state, and federal laws. Developers assume no liability and are not responsible for any misuse or damage caused by this program.