sundowndev
/
dorkgen
mirror of https://github.com/sundowndev/dorkgen.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: readme

pull/17/head
Raphaël 2020-09-06 16:44:10 +02:00 committed by GitHub
parent a1179e0de0
commit c3af638317
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -25,7 +25,14 @@ Dorkgen is a dork request generator for popular search engines such as Google Se
## Current status ## Current status
Version 1 is ongoing, but the API is still unstable. **For now, only Google's supported**, *v1.3* will introduce support for other search engines as well as a new design pattern. Version 1 is ongoing, but the API is still unstable. **See below table for supported search engines**.
| Search engine | Implementation status |
|---------------|:-----------------------:|
| [Google Search](https://godoc.org/github.com/sundowndev/dorkgen/googlesearch) | ✔️ |
| [DuckDuckGo](https://godoc.org/github.com/sundowndev/dorkgen/duckduckgo) | ✔️ |
| Yahoo Search | WIP |
| Bing Search | WIP |
## Install ## Install
@ -49,7 +56,8 @@ import "github.com/sundowndev/dorkgen"
func main() { func main() {
dork := dorkgen.NewGoogleSearch() dork := dorkgen.NewGoogleSearch()
// dork := dorkgen.NewDuckDuckGo() // dork := dorkgen.NewDuckDuckGo()
// dork := dorkgen.NewBing() // dork := dorkgen.NewBingSearch()
// dork := dorkgen.NewYahooSearch()
dork.Site("example.com").Intext("text").String() dork.Site("example.com").Intext("text").String()
// returns: site:example.com intext:"text" // returns: site:example.com intext:"text"
@ -64,7 +72,7 @@ func main() {
// returns: site:facebook.com | site:twitter.com // returns: site:facebook.com | site:twitter.com
dork.Intext("facebook").And().Intext("twitter").String() dork.Intext("facebook").And().Intext("twitter").String()
// returns: intext:"facebook" & intext:"twitter" // returns: intext:"facebook" + intext:"twitter"
} }
``` ```
@ -79,7 +87,7 @@ func main() {
Site("example.*"). Site("example.*").
Or(). Or().
Intext("text") Intext("text")
// returns: -site:example.com site:example.* OR "text" // returns: -site:example.com site:example.* | "text"
} }
``` ```