diff --git a/README.md b/README.md index 174caebfa6c6ef43a639fc5cf9563fa38409a596..ab2535e23693a10d670ea78e47cc7910f680dce6 100644 --- a/README.md +++ b/README.md @@ -69,15 +69,15 @@ go mod tidy If go.mod and go.sum are missing from the cloned repository, then: ``` # go mod init [module-path] -go mod init 0xacab.org/leap/vpn-hole/alter +go mod init 0xacab.org/leap/vpn-hole/vpnhole ``` ## Build & Run <a name="Build & Run"></a> To build the library and use it as a standalone: ``` -# navigate to app/alter +# navigate to app/vpnhole -cd app/alter +cd app/vpnhole # build the library @@ -112,10 +112,10 @@ sudo systemctl disable systemd-resolved To disable it permanently, uncomment and change `DNSStubListener` to *no* in `/etc/systemd/resolved.conf`; you can revert back everything to default if you stop using the vpn-hole library as a standalone. Also stop any other service which prevents from listening on port 53. Then, you can simply execute the binary file. -In **Windows**, an executable named- alter.exe would be created. +In **Windows**, an executable named- vpnhole.exe would be created. ``` # executing the binary -alter.exe +vpnhole.exe ``` This would start the network wide DNS-level blocker on port 53. @@ -141,14 +141,14 @@ To integrate the VPN-Hole Library with existing cross-platform applications, we ``` # For binding with Android Platforms: -cd vpn-hole/alter +cd vpn-hole/vpnhole # use gomobile to generate .aar: gomobile bind -target='android' -o path/for/the/output/filename.aar -v path/for/vpnhole.go For example: -# Here pwd is path/vpn-hole/alter +# Here pwd is path/vpn-hole/vpnhole gomobile bind -target='android' -o vpn-hole.aar -v diff --git a/app/alter/blacked.go b/app/vpnhole/blocklist.go similarity index 100% rename from app/alter/blacked.go rename to app/vpnhole/blocklist.go diff --git a/app/alter/handler.go b/app/vpnhole/handler.go similarity index 96% rename from app/alter/handler.go rename to app/vpnhole/handler.go index b4bfdf76022d9d1a177200a4781da5f9d8863379..20c1d8683aca38e8b7745126ba0e44ff78f96a2a 100644 --- a/app/alter/handler.go +++ b/app/vpnhole/handler.go @@ -5,7 +5,7 @@ import ( "log" "net" - "0xacab.org/leap/vpn-hole/alter/alter" + "0xacab.org/leap/vpn-hole/vpnhole/vpnhole" "github.com/miekg/dns" ) diff --git a/app/alter/main.go b/app/vpnhole/main.go similarity index 96% rename from app/alter/main.go rename to app/vpnhole/main.go index e7134ff01486574909f0aa1c880a54a19cd2455f..8af4c67c70d6e3ed62ab923d2bd382b3bcbdfc50 100644 --- a/app/alter/main.go +++ b/app/vpnhole/main.go @@ -5,7 +5,7 @@ import ( "fmt" "log" - "0xacab.org/leap/vpn-hole/alter/alter" + "0xacab.org/leap/vpn-hole/vpnhole/vpnhole" "github.com/miekg/dns" "time" diff --git a/app/alter/sublist.go b/app/vpnhole/sublist.go similarity index 100% rename from app/alter/sublist.go rename to app/vpnhole/sublist.go diff --git a/app/alter/subs.list b/app/vpnhole/subs.list similarity index 100% rename from app/alter/subs.list rename to app/vpnhole/subs.list diff --git a/alter/vpnhole.go b/vpnhole/vpnhole.go similarity index 97% rename from alter/vpnhole.go rename to vpnhole/vpnhole.go index ee34461ab28518b7acbcef3a7566902571b260bd..8c85daafdcdfc4380ec2c1e2724f9cd07772495b 100644 --- a/alter/vpnhole.go +++ b/vpnhole/vpnhole.go @@ -1,4 +1,4 @@ -package alter +package vpnhole import ( "fmt"