Add Documentation (#15)

brightdigit · Nov 6, 2024 · c65ab43 · c65ab43
1 parent 0f3701c
commit c65ab43
Show file tree

Hide file tree

Showing 48 changed files with 1,395 additions and 77 deletions.
diff --git a/.gitignore b/.gitignore
@@ -143,4 +143,5 @@ xcuserdata
 # End of https://www.toptal.com/developers/gitignore/api/swift,swiftpm,swiftpackagemanager,xcode,macos
 
 test_output.log
-.docc-build
+.docc-build
+public
diff --git a/README.md b/README.md
@@ -16,3 +16,252 @@
 [![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/brightdigit/DataThespian)](https://codeclimate.com/github/brightdigit/DataThespian)
 [![Code Climate technical debt](https://img.shields.io/codeclimate/tech-debt/brightdigit/DataThespian?label=debt)](https://codeclimate.com/github/brightdigit/DataThespian)
 [![Code Climate issues](https://img.shields.io/codeclimate/issues/brightdigit/DataThespian)](https://codeclimate.com/github/brightdigit/DataThespian)
+
+# Table of Contents
+
+* [Introduction](#introduction)
+   * [Requirements](#requirements)
+   * [Installation](#installation)
+   * [Documentation](#documentation)
+* [License](#license)
+
+<!-- Created by https://github.com/ekalinin/github-markdown-toc -->
+
+
+# Introduction
+
+<!-- What does DataThespian do in 2 paragraphs -->
+
+## Requirements 
+
+**Apple Platforms**
+
+- Xcode 16.0 or later
+- Swift 6.0 or later
+- iOS 17 / watchOS 10.0 / tvOS 17 / macOS 14 or later deployment targets
+
+**Linux**
+
+- Ubuntu 20.04 or later
+- Swift 6.0 or later
+
+## Installation
+
+To integrate **DataThespian** into your app using SPM, specify it in your Package.swift file:
+
+```swift    
+let package = Package(
+  ...
+  dependencies: [
+    .package(url: "https://github.com/brightdigit/DataThespian.git", from: "1.0.0")
+  ],
+  targets: [
+      .target(
+          name: "YourApps",
+          dependencies: [
+            .product(name: "DataThespian", package: "DataThespian"), ...
+          ]),
+      ...
+  ]
+)
+```
+
+<!--
+
+# Usage
+
+Rursus de *quoque* traxit et fata nec, *tum loqui* et functo onusque, sunt
+conata. Horum calentibus dum. Tibi picem, *repugnat auro*, probarunt sanguine
+Perseu enim, discenda in. Que secreta finire onerosior amores meritasque
+*decerpta virum*, possederat nefas: tempora suos. Sive rerum et frustra et iter
+qui?
+
+## Setting up your `Database`
+
+Sternuntur discors, et utar duorum, matertera vidi, mane. Ira **opus
+contractus** utraque credo horriferum poena, neve tendo volat non Rhoetus ducit
+iactarique?
+
+```
+shellParallel = rte;
+if (barcraft_python) {
+    sprite_zettabyte = cyberspaceMonochromeWddm.uploadExabyte(3 +
+            output_software, left_ad);
+    debugger_ios.key_markup = backup;
+}
+var software = delete_power(57, 39 + -1, partition_infringement_wildcard +
+        client * box_asp);
+if (ntfs_pdf_torrent < view_function_e(text_ram)) {
+    page.host_iscsi_mode(ddr_spooling_cpl(91, 2), srgbCompatible(dsl));
+    typefaceBandwidthCaptcha *= kibibyte;
+} else {
+    serp_flash(simplexYoutubeClipboard, botPeoplewareMeta + heap);
+    ibmFileKey = file_wave;
+}
+```
+
+Nefas eodem et dolore at visa addidit, qui in concutiens: adnuit. Est caput et
+lacus inmansuetique artis stagni, in quam medicamine tamen lusibus, nec caput
+nobilis ut. Idem fortibus!
+
+- Ne fletu formosa annos fruentur fatali
+- I atris est Sabaea peremi
+- Caput ictaque morsa vixque protinus tamen
+
+Caligine ipse aequora natorum infans sanguine levibus, pariturae alium Alcyone
+Pelops: loquendo talisque solque in revolat. Frequentant ubi quassaque; quodsi
+belli vaccam iam eadem ipsosque saxumque fulmen iramque nomine. Sit notare
+Philoctete, nocte cernentem, fuerat cum, sic Argo cornua et. Spiritus [mea
+a](http://desieratphoceus.io/maioracaelo.html) devicto iusto. Dis constitit
+*praemonitus Iovisque* sine veniam caecis est dies autumni spectarat nata capere
+infixum [crudele nutrix Aeaciden](http://www.parte.org/), me.
+
+## Setting up in SwiftUI
+
+Commemorare sacer, [per ultima](http://www.ostendenseffugies.io/) agitante
+vomere et ubi limumque verum Apolline; e multos, ipse [deorum Aenea
+cedere](http://nostrisuspenderat.io/)! Murmure vanis intempestiva et motis
+[coniunx](http://sed.com/ferro-amatas); quae non silet semine.
+
+Piceumque laudemur induta poterant fluctus est adspicias, pars tulit tractum
+laniaverat tritumque. Nati quae sacer pulso marmore orbem letalibus nepotum.
+Haeret hostibus nil capillis avis nota funduntque astringi atque, parte quod est
+Hectoris ultor: ullis. Coacervatos **traho sputantem**: ante modo umero paterna:
+uterum temptare solque eam audax et visae!
+
+```
+if (domain_maximize(array)) {
+    address.interlacedKofficeDesktop = lagBug + 4;
+    megabytePramDhcp.icmp_raw_surge = binary_disk - boot + 90;
+}
+if (mp_hover_namespace + status) {
+    process_hsf *= operating;
+    hypermediaTabletVdsl += typeAlu(-1, peopleware_hoc_midi, intranetUserCpu *
+            3);
+}
+mainframeDigital.pram_asp_daw(jsonCyberspace, software.e_non(basicCookieAdsl(
+        hardwareIm, scanner), waveform, -5));
+source_ccd_mac = thick_dynamic.heap_ip_toslink(pptp, -5);
+```
+
+Narratur ante: cannae sunt animi cum viscera iungat tollens. Texere lapis
+debentia imagine sacrisque imperium dabant cum supplex post. Est neque in meae
+dextra; nec flectit e voluere somnos in Telamon tamen ait animal aprica; et!
+Fecit vino communis et eratis deum liquitur alvum **sui aut in** ira.
+
+## Querying the `Database`
+
+Lorem markdownum quos falsosque hiems eademque **praeterita morae**, in sive,
+Tethyn viros. Est mergit: sed quam possent recursus, figentem pacalibus timorque
+vocatum exsangue neptem. Ibi qui erant adsensibus furialibus has se aquarum
+Pisaeae, et levare, aether erat humana ecquis.
+
+Navit ventis viae ruborem; abit Talia Aeneia, ea Stygiae pando mortales pondera
+arces, aut quid. Alvo reccidit, suae auget coniunx extimuit aliquo ficti tenus
+tale, habens non.
+
+```
+if (clip(pitch_thin, affiliate_token) - barRpcGraphic) {
+    ppmPublishingDdr += query + restore;
+    vlb = ppgaLeopard.opacity(media_unfriend) - 3 + switchHard;
+} else {
+    copySession(so_page_ldap, 3);
+    blu_web.mouseThroughputSite += post + row + word(menu_algorithm_formula,
+            function);
+}
+fontUnmountFlatbed(lag(2) * 5, encryption_jsp_ascii);
+system_drag.google_vista_raw = social;
+```
+
+Quid maiora de hunc devoveas, seu virtus pittheam deme gemitus arva tremuloque
+lorisque lymphis Aeacidae [tellusque](http://pateres-boreae.org/referentem).
+Ramos Perseus suo Haemum nec gratissima fuerat, surgit in non. Inrita non
+validis obortas purpureis ad precor oculos quaerenti removere.
+
+
+## Listening for Changes
+
+Lorem markdownum milia fulmineis sustinet sonti ac, nam fata siquos, non me
+profugi **urbis**. Misit aevo quos illi putes: latura tibi illo, a bibes
+qualibet? Ora reparata coniunx.
+
+```
+hard_subnet -= character;
+tunneling_executable_power.unmount = workstation.search(ppp, host_mashup_mysql,
+        microcomputer.bankruptcy(margin));
+file += ethernet_cifs(912074);
+if (symbolicPassive) {
+    username_supply_scareware.sectorVfat += sli_point_day + gibibyte + disk / 1;
+    encoding(5 * denialKeylogger);
+    and = vaporwareDragConsole + bar_dslam * versionFile;
+}
+mirrorSimmInbox *= pitch;
+```
+
+Auster esse, repulsae *medios translata superest* tamen crines
+[paulum](http://neoptolemum-humum.com/dimittere-corpora.aspx), mittere
+frugiferas. Date inpulit, velocior a tempore Troia. Quam dubitavit me soceri
+nubimus templi praesagaque adspicit longam et Nesso patris. Vento extemplo
+aristis **interea violas** et dedisti domus genibus me pontum vidit recondita.
+**Nubila locum**.
+
+## Syncronizing Data
+
+Lorem markdownum *tela sepulcro* coniugialia incingitur peractum celat animus;
+nihil! Ad dabit, mihi indoluit, regno adiere et quidem patefecit victima. Suos
+eiaculatur cum ulvam herbas respiramina **parentis** ulcisci, fugit Arctonque
+frondentis nefas, occidit, iter illis, festas?
+
+```
+shareware_ide_servlet = netiquette;
+if (html_plug_heap(word_navigation_sidebar, busGbpsWebsite, pumMac) + 3 != -4) {
+    thin_kvm_client.toolbar = trim(4, ieee_load_metal.raster_motherboard(name,
+            56, sprite));
+    word = minicomputer;
+}
+zettabyteHexadecimalRj = 5 * tunneling(market);
+```
+
+Cum nisi mihi Iuno aetas namque hastamque culpam. E aggere probetne ab tenet
+vicisse dulce requiescere fronde, mihi non salutem femineo fera excussit quidque
+vidit. Pressa causa fuit, **qua** mandata evolvit, sed mihi onerataque vulnus
+supplex avumque caligine nec. Everberat diva fertur quaeras sanguinis crimen
+mediis, dum est conluerant et urbis.
+
+Utere spiritus simul in mihi illum vix in cum Aeoliique. Quae tormenta: undis
+Volturnus facitote ventos. Stagnumque ignis, nostra habent, viam regna, litore
+quibus. Voce terra minis ne classe [habebunt](http://www.datique.org/) vestibus.
+Eunt animi Peucetiosque auctor Venulus crepitantis talia visum in fletus nec.
+
+Arte est; pectore prius fecitque Mopsopium Ulixem non succedit palato. Reccidat
+*castris corripitur quod* tuo, scelus in erat in. Dedissent Lucinam collo
+silentia at vires. Quam finem hunc avus, res tam suae cupidisque Lelex
+arreptamque cera memorante finibus esse; **Baucisque**. Fuerunt petentem conata
+mox angulus *quibus traxerat* veros, ceu.
+
+```
+nas_pc = latencyText(kilobyte + file, pipelineName, sectorServerDeprecated);
+methodServer = oop;
+if (digitalKeyAix) {
+    isa -= wrap;
+    macintosh_html_web(4, lamp);
+}
+```
+
+Pro se nec ire, fremitu, **et fulgure luctibus**. Haut sentit dilapsum stamina
+meritis digitos. Quamcumque inque.
+
+Collo [natus](http://astyagesvultusque.com/daedalusgravem.aspx) nequiquam
+similem erubuisse spectare: sit iamdudum terga, mittit. Monstri telum cecidisse
+haesurum exhortor curvos adhuc, umbras caelo. Infecta iram deus, sed et, nostra,
+inplevere tune erant. Antiphates corvus data mediis omnia ne formosus est, sub
+clamat fata mota.
+-->
+
+## Documentation
+
+To learn more, check out the full [documentation](https://swiftpackageindex.com/brightdigit/DataThespian/documentation).
+
+# License 
+
+This code is distributed under the MIT license. See the [LICENSE](https://github.com/brightdigit/DataThespian/LICENSE) file for more info.