updated readme

readme.md

@@ -20,39 +20,16 @@ for index, sub := subdomains {
 ...
 ```
 
-### Functions
+### Documentation
 
-#### SubdomainsOnly
-
-- Returns: only the subdomains (subdomain.example.com) as a slice of strings
-
-
-#### DomainsOnly
-
-- Returns: only the domains (example.com) as a slice of strings
-
-
-#### BreakFusedSubdomains
-
-- Returns: the subdomains/domains that are fused on accident, split into newlines
-
-Example: en.wikipedia.org0x4f.medium.com gives
-            en.wikipedia.org
-            0x4f.medium.com
-
-
-#### SubdomainAndDomainPair
-
-- Returns: a struct containing a subdomain and its domain
+Visit https://pkg.go.dev/github.com/0x4f53/textsubs to read about the functions and their descriptions
 
 
 ### Working
 This package uses [publicsuffix2](https://github.com/weppos/publicsuffix-go), basic regex matching and a few if-else statements to determine if a string containing dots
 is a subdomain or not. Please note that certain strings like "readme.md" will be marked as valid subdomains due to
 _.md_ being a valid TLD.
 
-This package does not resolve/validate the subdomains or domains it captures.
-
 ---
 
 Copyright (c) 2024  Owais Shaikh

textsubs.go

@@ -309,7 +309,7 @@ func checkSubdomain(subdomain string, wg *sync.WaitGroup, results chan<- map[str
 }
 
 //		Returns: a map of format (item, bool) containing items (subdomains or domains) after checking
-//				if they resolve when pinged (using LookupHost)
+//				if they resolve when pinged (using LookupHost and waitgroups)
 //		Example: [0x4f.in play.google.com fakesite123131231.dev] gives
 //			{0x4f.in : true, play.google.com, fakesite123131231.dev : false}
 //		Inputs: