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
+6 -8
View File
@@ -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 [email protected] --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.