edit readme

Signed-off-by: Hadi <[email protected]>
This commit is contained in:
Hadi
2025-05-20 22:14:32 +02:00
parent a3f4b19382
commit de47073083
2 changed files with 16 additions and 8 deletions
+10
View File
@@ -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.
+6 -8
View File
@@ -47,6 +47,8 @@ go get github.com/anotherhadi/gh-recon
### With Nix/NixOS ### With Nix/NixOS
<details>
<summary>Click to expand</summary>
**From anywhere (using the repo URL):** **From anywhere (using the repo URL):**
```bash ```bash
@@ -69,6 +71,8 @@ environment.systemPackages = with pkgs; [ # or home.packages
]; ];
``` ```
</details>
## Usage ## Usage
```bash ```bash
@@ -77,8 +81,6 @@ gh-recon --username TARGET_USER [--token YOUR_TOKEN]
### Flags ### Flags
- `--token`: Personal Access Token (optional but recommended)
```txt ```txt
-deep -deep
Enable deep scan (clone repos, regex search, analyse licenses, etc.) Enable deep scan (clone repos, regex search, analyse licenses, etc.)
@@ -104,10 +106,6 @@ gh-recon --email [email protected] --token ghp_ABC123...
gh-recon --username anotherhadi --json output.json --deep gh-recon --username anotherhadi --json output.json --deep
``` ```
## Todo ## Contributing
Feel free to contribute! Feel free to contribute! See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
**Todo:**
- Find and parse licenses