update readme again, start PACKAGECONF.md

This commit is contained in:
idk
2018-12-04 11:47:48 -05:00
parent 5c13d44e14
commit 992dc1d464
3 changed files with 47 additions and 18 deletions

View File

@ -22,15 +22,28 @@ and it will be in the folder ./bin/
[![Build Status](https://travis-ci.org/eyedeekay/sam-forwarder.svg?branch=master)](https://travis-ci.org/eyedeekay/sam-forwarder) [![Build Status](https://travis-ci.org/eyedeekay/sam-forwarder.svg?branch=master)](https://travis-ci.org/eyedeekay/sam-forwarder)
## [usage/configuration](docs/USAGE.md) ## Usage:
There are a number of ways to use sam-forwarder:
### [usage/configuration](docs/USAGE.md) as an application(Start here for samcatd)
### [embedding](docs/EMBEDDING.md) in other applications
### [encapsulate](docs/PACKAGECONF.md) configuration for i2p-enabled packages
## binaries ## binaries
Two binaries are produced by this repo. The first, ephsite, is only capable Two binaries are produced by this repo. The first, ephsite, is only capable
of running one tunnel at a time. The second, samcatd, is more advanced. It can of running one tunnel at a time and doesn't have VPN support. I'm only updating
start multiple tunnels with their own settings, or be used to start tunnels on it to make sure that the embeddable interface in existing applications doesn't
the fly like ephsite by passing the -s option. Eventually I'm probably just change. It will go away and be replaced with a wrapper to translate it to
going to use this to configure all of my tunnels. 'samcatd -s' commands whenever I complete [docs/CHECKLIST.md](docs/CHECKLIST.md).
The second, samcatd, is more advanced. It can start multiple tunnels with their
own settings, or be used to start tunnels on the fly like ephsite by passing the
-s option. Eventually I'm probably just going to use this to configure all of my
tunnels.
Current limitations: Current limitations:
==================== ====================

View File

@ -25,15 +25,28 @@ and it will be in the folder ./bin/
[![Build Status](https://travis-ci.org/eyedeekay/sam-forwarder.svg?branch=master)](https://travis-ci.org/eyedeekay/sam-forwarder) [![Build Status](https://travis-ci.org/eyedeekay/sam-forwarder.svg?branch=master)](https://travis-ci.org/eyedeekay/sam-forwarder)
## [usage/configuration](docs/USAGE.md) ## Usage:
There are a number of ways to use sam-forwarder:
### [usage/configuration](docs/USAGE.md) as an application(Start here for samcatd)
### [embedding](docs/EMBEDDING.md) in other applications
### [encapsulate](docs/PACKAGECONF.md) configuration for i2p-enabled packages
## binaries ## binaries
Two binaries are produced by this repo. The first, ephsite, is only capable Two binaries are produced by this repo. The first, ephsite, is only capable
of running one tunnel at a time. The second, samcatd, is more advanced. It can of running one tunnel at a time and doesn't have VPN support. I'm only updating
start multiple tunnels with their own settings, or be used to start tunnels on it to make sure that the embeddable interface in existing applications doesn't
the fly like ephsite by passing the -s option. Eventually I'm probably just change. It will go away and be replaced with a wrapper to translate it to
going to use this to configure all of my tunnels. 'samcatd -s' commands whenever I complete [docs/CHECKLIST.md](docs/CHECKLIST.md).
The second, samcatd, is more advanced. It can start multiple tunnels with their
own settings, or be used to start tunnels on the fly like ephsite by passing the
- -s option. Eventually I'm probably just going to use this to configure all of my
tunnels.
Current limitations: Current limitations:
==================== ====================
@ -103,12 +116,12 @@ Donate
BTC:159M8MEUwhTzE9RXmcZxtigKaEjgfwRbHt BTC:159M8MEUwhTzE9RXmcZxtigKaEjgfwRbHt
-----BEGIN PGP SIGNATURE----- -----BEGIN PGP SIGNATURE-----
iQEzBAEBCAAdFiEEcNIGBzi++AUjrK/311wDs5teFOEFAlwGpYIACgkQ11wDs5te iQEzBAEBCAAdFiEEcNIGBzi++AUjrK/311wDs5teFOEFAlwGr7EACgkQ11wDs5te
FOFW+AgAhemc3zMLe+d93oipWgrYgxtCpu1t2yQgz0zOF5tfAlyjSLzbf7daDrXo FOFwMAf/dgup5p7BXy5pbqoSYIwPUrs+tK6eGiYd4aCs4a1xdJNRr+jNcw3zUmFx
1J5vkYg5HYV6Y6WVEbPEW2sT7hXcsLydUgdiUYDUYKZxw6Jz+WrOjnydqcSp8DMl Y/Qzrlcgy4DlYroGKPWAPuQ5XKRpWaARy59jZt43ZZ+d8R0jvYlyQQaJcUlmPAl8
4qEfHnDWH3soou1XWVkIHdrZ1jcmnukIYOcdR1Rrcucajd2FuJYSlVY/lyQwpd0L SEQxw3DBP+ovAS+CTjmNRBAIfga+DLEpczgU/Z3TAmRdIN/Ibw7P+X4x+vQrW7lD
3PuPY1QKjwvUmPSVCqyJDIkHebV+upxS8Vej6ifBh/odmZag7VmBeNmyEiZZ9vH2 f3G8o8W7ESRs4x6JD/7DbJ2fUa3cqvgAzJGESb/IwMUQX094qc7rUXDJti6xBtc/
Uti51jUcypSUPC3MnbTvwpgrQW2DQDNUDS9agfDjdrY//gS7oL5rV6ka5t9ZFDOa yh2OfCdHr+YVEHe/uA3DRROBriTUJ5kVlNta7fulNit8cZMhuEAdaID6ka0OLM4n
yH8bbmvesEyDAjuOPmO1sl/NIVFGOA== guowmm9mjPnPfLL53LaeC4TVEmn7Zg==
=0DWU =8gZU
-----END PGP SIGNATURE----- -----END PGP SIGNATURE-----

3
docs/PACKAGECONF.md Normal file
View File

@ -0,0 +1,3 @@
Encapsulating and Packaging Application Configuration with samcatd
==================================================================