diff --git a/index.html b/index.html index 1779721..7dcbef0 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ goi2pbrowser - + @@ -41,68 +41,121 @@

goi2pbrowser

-

- – - import “github.com/eyedeekay/go-i2pbrowser” -

Package goi2pbrowser is a package which can be used to manage an I2P browsing - profile using a pre-configured, common profile which is used by the I2P - Easy-Install bundle and the i2p.plugins.firefox profile manager. It is a Go - clone of i2p.plugins.firefox for use in native applications. + profile using a pre-configured, common profile which is used by the I2P Easy-Install + bundle and the i2p.plugins.firefox profile manager. It is a Go clone of + i2p.plugins.firefox for use in native applications.

- Usage + Variables

-
var BaseProfile []byte
+    

+ BaseProfile is a zip of a Firefox profile with NoScript, HTTPS Everywhere, and I2PIPB +

+
var BaseProfile []byte
 

- BaseProfile is a zip of a Firefox profile with NoScript, HTTPS Everywhere, and - I2PIPB + UsabilityProfile is a zip of a Firefox profile with Jshelter, HTTPS Everywhere, uBlock Origin, LocalCDN, OICT, and I2PIPB

-
var UsabilityProfile []byte
+    
var UsabilityProfile []byte
 
+

+ Functions +

+

+ func + + BrowseApp + +

- UsabilityProfile is a zip of a Firefox profile with Jshelter, HTTPS Everywhere, - uBlock Origin, LocalCDN, OICT, and I2PIPB + + func BrowseApp(profileDir string, url ...string) +

-

- func BrowseStrict -

-
func BrowseStrict(profileDir, url string)
-

- BrowseStrict launches a Firefox browser configured to use I2P and waits for it - to exit. The profile is in “Strict” mode + BrowseApp launches a Firefox browser configured to use I2P and waits for it to exit. + The profile is in “Usability” mode

-

- func BrowseUsability -

-
func BrowseUsability(profileDir, url string)
-
+

+ func + + BrowseStrict + +

- BrowseUsability launches a Firefox browser configured to use I2P and waits for - it to exit. The profile is in “Usability” mode + + func BrowseStrict(profileDir string, url ...string) + +

+

+ BrowseStrict launches a Firefox browser configured to use I2P and waits for it to exit. + The profile is in “Strict” mode +

+

+ func + + BrowseUsability + +

+

+ + func BrowseUsability(profileDir string, url ...string) + +

+

+ BrowseUsability launches a Firefox browser configured to use I2P and waits for it to exit. + The profile is in “Usability” mode +

+

+ func + + UnpackBase + +

+

+ + func UnpackBase(profileDir string) (string, error) +

-

- func UnpackBase -

-
func UnpackBase(profileDir string) (string, error)
-

UnpackBase unpacks a “Strict” mode profile into the “profileDir” and returns the - path to the profile and possibly, an error if something goes wrong. If - everything works, the error will be nil + path to the profile and possibly, an error if something goes wrong. If everything + works, the error will be nil

-

- func UnpackUsability -

-
func UnpackUsability(profileDir string) (string, error)
-
+

+ func + + UnpackUsability + +

- UnpackUsability unpacks a “Usability” mode profile into the “profileDir” and - returns the path to the profile and possibly, an error if something goes wrong. - If everything works, the error will be nil + + func UnpackUsability(profileDir string) (string, error) + +

+

+ UnpackUsability unpacks a “Usability” mode profile into the “profileDir” and returns the + path to the profile and possibly, an error if something goes wrong. If everything + works, the error will be nil +

+

+ Sub Packages +

+ +
+

+ Readme created from Go doc with + + goreadme +

diff --git a/style.css b/style.css index 963d79f..748f998 100644 --- a/style.css +++ b/style.css @@ -36,6 +36,7 @@ img { left: 5%; max-width: 60%; display: inline; + padding-right: 2%; } .inline {