Update: README.md

ndelphit · May 6, 2020 · cdc7154 · cdc7154
1 parent fa810f8
commit cdc7154
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,27 @@
-# apkurlgrep
-Extract endpoints from APK files
+# ApkUrlGrep
+Tool that allow extract endpoints from APK files
+
+
+## Install
+
+```
+▶ go get -u github.com/ndelphit/apkurlgrep
+```
+
+## Usage
+
+
+```
+▶ apkurlgrep -a ~/path/to/file.apk
+Result of URLs:
+
+https://example.com
+https://example.net
+https://example.edu
+
+Result of URLs Paths:
+
+/example
+/admin
+/onboarding
+```
diff --git a/apkurlgrep.go b/apkurlgrep.go
@@ -1,5 +1,5 @@
 /*
- with love by @ndelphit 5/2020
+ made with love by @ndelphit 5/2020
 */
 
 package main
@@ -18,7 +18,7 @@ import (
 
 func main() {
 
-	parser := argparse.NewParser("apkurlgrep", "ApkUrlGrep")
+	parser := argparse.NewParser("apkurlgrep", "ApkUrlGrep - Extract endpoints from APK files")
 	apk := parser.String("a", "apk", &argparse.Options{Required: true, Help: "Input a path to APK file."})
 
 	err := parser.Parse(os.Args)