From de47073083ed8df7b1bdd0d2e59d01f1539fbef4 Mon Sep 17 00:00:00 2001
From: Hadi <112569860+anotherhadi@users.noreply.github.com>
Date: Tue, 20 May 2025 22:14:32 +0200
Subject: [PATCH] edit readme

Signed-off-by: Hadi <112569860+anotherhadi@users.noreply.github.com>
---
 CONTRIBUTING.md | 10 ++++++++++
 README.md       | 14 ++++++--------
 2 files changed, 16 insertions(+), 8 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..66aac25
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,10 @@
+# Contributing
+
+Everybody is invited and welcome to contribute to this repo. There is a lot to do... Check the issues!
+
+The process is straight-forward.
+
+- Read [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews) by Kubernetes. (but skip step 0 and 1)
+- [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) this repo.
+- Write your changes (bug fixe, new feature, issues fix, ...).
+- Create a Pull Request against the main branch.
diff --git a/README.md b/README.md
index 8596dbc..d617bac 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,8 @@ go get github.com/anotherhadi/gh-recon
 
 ### With Nix/NixOS
 
+<details>
+<summary>Click to expand</summary>
 **From anywhere (using the repo URL):**
 
 ```bash
@@ -69,6 +71,8 @@ environment.systemPackages = with pkgs; [ # or home.packages
 ];
 ```
 
+</details>
+
 ## Usage
 
 ```bash
@@ -77,8 +81,6 @@ gh-recon --username TARGET_USER [--token YOUR_TOKEN]
 
 ### Flags
 
-- `--token`: Personal Access Token (optional but recommended)
-
 ```txt
   -deep
      Enable deep scan (clone repos, regex search, analyse licenses, etc.)
@@ -104,10 +106,6 @@ gh-recon --email myemail@gmail.com --token ghp_ABC123...
 gh-recon --username anotherhadi --json output.json --deep
 ```
 
-## Todo
+## Contributing
 
-Feel free to contribute!
-
-**Todo:**
-
-- Find and parse licenses
+Feel free to contribute! See [CONTRIBUTING.md](CONTRIBUTING.md) for details.