go-i2p/go-i2pbrowser
1
0
Fork 0
mirror of https://github.com/go-i2p/go-i2pbrowser.git synced 2025-06-08 02:28:19 -04:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
idk
2022-10-21 21:50:51 -04:00
parent 51eac0c072
commit 753d6cd406
1 changed files with 47 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
README.md
View File

@ -1,56 +1,66 @@
# 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
```go
BaseProfile is a zip of a Firefox profile with NoScript, HTTPS Everywhere, and I2PIPB
```golang
var BaseProfile []byte
```
BaseProfile is a zip of a Firefox profile with NoScript, HTTPS Everywhere, and
I2PIPB
```go
UsabilityProfile is a zip of a Firefox profile with Jshelter, HTTPS Everywhere, uBlock Origin, LocalCDN, OICT, and I2PIPB
```golang
var UsabilityProfile []byte
```
UsabilityProfile is a zip of a Firefox profile with Jshelter, HTTPS Everywhere,
uBlock Origin, LocalCDN, OICT, and I2PIPB
#### func BrowseStrict
## Functions
```go
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
### func [BrowseApp](/run.go#L53)
#### func BrowseUsability
`func BrowseApp(profileDir string, url ...string)`
```go
func BrowseUsability(profileDir, url string)
```
BrowseUsability launches a Firefox browser configured to use I2P and waits for
it to exit. The profile is in "Usability" mode
BrowseApp launches a Firefox browser configured to use I2P and waits for it to exit.
The profile is in "Usability" mode
#### func UnpackBase
### func [BrowseStrict](/run.go#L15)
`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](/run.go#L34)
`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](/unembed.go#L22)
`func UnpackBase(profileDir string) (string, error)`
```go
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](/unembed.go#L41)
```go
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
`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
* [i2pbrowser](./i2pbrowser)
---
Readme created from Go doc with [goreadme](https://github.com/posener/goreadme)