Browse Source

docs(module/toxic-swamp): update features, installation and internationalization

Josh Habdas 11 months ago
parent
commit
4778b6711a
Signed by: Josh Habdas <jhabdas@protonmail.com> GPG Key ID: B148B31154C75A74
1 changed files with 30 additions and 61 deletions
  1. 30
    61
      docs/content/module/toxic-swamp.md

+ 30
- 61
docs/content/module/toxic-swamp.md View File

@@ -64,56 +64,19 @@ Basic set-up is simple. October 2018 hard fork supported. Works with both Crypto
64 64
 
65 65
 ## Features
66 66
 
67
-General:
68
-
69
-- Start earning rewards the moment you begin creating your website
70
-- Monetize your users based on the level of attention they provide
71
-- Incentivize yourself to keep your software up-to-date and secure
72
-- Build user trust with transparent metrics and control mechanisms
73
-- Protect users by obfuscating their IP with included proxy server
74
-- Automatically selects the most appropriate language for the user
75
-
76
-Interface:
77
-
78
-- At-a-glance hash metrics
79
-- Transparent worker state
80
-- User-adjustable hashrate
81
-- Detailed status messages
82
-- One-click on/off setting
83
-- Accessible user controls
84
-
85
-Behavior:
86
-
87
-- Auto-starts with simple opt-out
88
-- Disables itself unless charging
89
-- Remembers user-defined settings
90
-- Purges user data following session
91
-- Enters standby when attention lost
92
-- Obfuscates proxy server settings
93
-- Obfuscates end-user IP via proxy
94
-
95
-Technical:
96
-
97
-- Supports CrytoNight/CryptoNight-Lite
98
-- Efficient client miner using ASM/WASM
99
-- Rust proxy server with full sources
100
-- WebSocket persists proxy connection
101
-- Compiles with Mono or Mono in Docker
102
-- Comprehensive pool settings included
103
-- Configurable client-side debugging
104
-- Loads quickly with [Fetch Injection](/feature/fetch-injection)
105
-- Uses automatic multi-thread detection
106
-- Automatic TLS certs with cron renewal
67
+- Transparent, unobtrusive multilingual user interface
68
+- Does not use cookies or connect to any third-parties
69
+- Automatically starts when external power is detected
70
+- Suspends operation during loss of power or attention
71
+- Functions like an application without the complexity
107 72
 
108 73
 ## Installation
109 74
 
110
-Depending on your configuration Toxic Swamp can be run stand-alone using [The Fire Swamp](#the-fire-swamp) proxy or full-stack using the source code included in the module.
111
-
112 75
 Choose a module download source:
113 76
 
114
-- {{< external "https://www.npmjs.com/package/toxic-swamp" />}}
115
-- {{< external "https://www.jsdelivr.com/package/npm/toxic-swamp" />}}
116
-- {{< external "https://git.habd.as/comfusion/toxic-swamp" />}}
77
+- {{< external "https://www.npmjs.com/package/toxic-swamp" />}} - npm
78
+- {{< external "https://www.jsdelivr.com/package/npm/toxic-swamp" />}} - cdn
79
+- {{< external "https://git.habd.as/comfusion/toxic-swamp" />}} - git
117 80
 
118 81
 Extract module contents into site themes directory:
119 82
 
@@ -124,6 +87,13 @@ Extract module contents into site themes directory:
124 87
     └── toxic-swamp
125 88
 ```
126 89
 
90
+Verify [Release Hash](/feature/release-hashes) and signing key:
91
+
92
+```sh
93
+cd themes/toxic-swamp && \
94
+npm install && npm run integrity
95
+```
96
+
127 97
 Specify module in site config:
128 98
 
129 99
 {{< highlight toml "linenos=inline,linenostart=6" >}}
@@ -134,19 +104,10 @@ theme = [
134 104
 ]
135 105
 {{< /highlight >}}
136 106
 
137
-{{< hackcss-alert type="success" >}}
138
-Miner functional! It's recommended you run your own proxy during the beta. <span hidden>A few more steps and you'll be safe in the fire swamp.</span>
139
-{{< /hackcss-alert >}}
140
-
141
-Optionally, verify the module [Release Hash](/feature/release-hashes):
142
-
143
-```sh
144
-cd themes/toxic-swamp && \
145
-npm install && npm run integrity
146
-```
107
+{{% hackcss-alert type="success" %}}**Success!** Miner now functional. Rebuild your site to view the changes.{{% /hackcss-alert %}}
147 108
 
148 109
 <a id="config-generator"></a>
149
-Then generate your configuration to begin earning rewards:
110
+Generate module config to begin earning rewards:
150 111
 
151 112
 {{< hackcss-card header="Interactive Config Generator" >}}
152 113
   {{< hackcss-form name="generator" disabled="true" action="http://localhost:1414/module/toxic-swamp/configuration/" >}}
@@ -309,11 +270,11 @@ Then generate your configuration to begin earning rewards:
309 270
   </script>
310 271
 {{< /hackcss-card >}}
311 272
 
312
-Unless you specify a custom proxy you will begin mining in [The Fire Swamp](#the-fire-swamp). Use `Advanced Settings` to set a custom proxy or come back later once you've survived the three terrors which lie ahead.
273
+Toxic Swamp may be run stand-alone using a single payout address and [The Fire Swamp](#the-fire-swamp) or full-stack with `Advanced Settings` once you [Create Your Own Proxy](#create-your-own-proxy).
313 274
 
314 275
 ## The Fire Swamp
315 276
 
316
-After Dark provides a proxy called The Fire Swamp using {{< external href="https://moneroocean.stream/?dark" text="MoneroOcean" />}} to help you get started and as a fallback when custom proxies fail to connect.
277
+After Dark provides upgrade incentives The Fire Swamp using {{< external href="https://moneroocean.stream/?dark" text="MoneroOcean" />}} to help you get started and as a fallback when custom proxies fail to connect.
317 278
 
318 279
 The proxy servers are located at `fs*.habd.as:80` and will be used by default until you [Create Your Own Proxy](#create-your-own-proxy) or fall more than two major versions behind.
319 280
 
@@ -600,7 +561,13 @@ And may be adjusted by updating the `languageCode` from site config:
600 561
 languageCode = "id-ID" # Controls site language
601 562
 ```
602 563
 
603
-### Customizing
564
+### Preferred Language
565
+
566
+Text presented to the user will appear in the preferred language. Preferred language is derived from HTML and browser settings. If not specified by the HTML it will be inferred from the browser's language setting.
567
+
568
+If a translation is available for the preferred language it will be displayed. Otherwise English will be selected by default.
569
+
570
+### Customizing Translations
604 571
 
605 572
 Add or remove translations from `inline.jsonld.html` in your site `layouts` directory. If the file doesn't exist yet, copy it from module default:
606 573
 
@@ -611,13 +578,15 @@ cp themes/toxic-swamp/layouts/partials/modules/toxic-swamp/inline.jsonld.html $_
611 578
 
612 579
 {{% hackcss-alert type="info" %}}**Tip:** See [Custom Layouts](/feature/custom-layouts/) for help customizing your layouts.{{% /hackcss-alert %}}
613 580
 
614
-And adjust their availability using the `translations` setting in site config:
581
+Adjust availability using the `translations` setting in site config:
615 582
 
616 583
 ```toml
617 584
 [params.modules.toxic_swamp]
618
-  translations = ["id", "es"] # optional, specifies English translations available
585
+  translations = ["id-ID"] # optional, specifies English translations available
619 586
 ```
620 587
 
588
+Translations will not be presented to the user if not specified.
589
+
621 590
 ---
622 591
 
623 592
 <small class="muted" id="mining-footnote"><sup>†</sup> Estimate assumes 50%  {{< external href="https://coinhive.com/info/faq#rev-share" text="non-negotiable" />}} Coinhive mining fee compared with 0% for {{< external href="https://moneroocean.stream/?dark#/help/faq" text="MoneroOcean" />}} and excludes optional donation, hashrate variance, uptime, withdrawal fees and optimizations. <a href="#footnote-return">↩</a></small>

Loading…
Cancel
Save