golgi-ssb
/
website
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

add motivation and thanks section plus ignore file

This commit is contained in:
glyph 2022-02-17 10:57:04 +02:00
parent a9a7e3d8d2
commit e4ac3df548
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
sync.sh

9
index.html
View File

@ -88,9 +88,14 @@
<ul style="padding: 0;">
<li class="list-item"><a href="https://crates.io/crates/golgi" title="golgi crate">Crate</a></li>
<li class="list-item"><a href="https://git.coopcloud.tech/golgi-ssb/golgi" title="golgi git repository">Git Repository</a></li>
<li class="list-item"><a href="http://golgi.mycelial.technology/api" title="golgi API documentation">API Documentation</a></li>
<li class="list-item"><a href="https://dev.scuttlebutt.nz/#/rust/golgi" title="golgi developer documentation">Developer Documentation</a></li>
<li class="list-item"><a href="https://docs.rs/golgi/0.1.0/golgi/" title="golgi API documentation">API Documentation</a></li>
<li class="list-item"><a href="https://dev.scuttlebutt.nz/#/rust/golgi" title="golgi developer guide">Developer Guide</a></li>
</ul>
<h2>Motivation</h2>
<p>For the longest time, Scuttlebutt client development has been almost exclusively limited to JavaScript. As a result, many developers have refrained from attempting to build their own clients. An additional hurdle, and one which often stymies even the most enthusiastic of Scuttlebutt newcomers, is the fact that methods for getting and setting data are distributed across a wide range of JavaScript modules—each with their own peculiarities and varying degrees of thoroughness when it comes to documentation. This is not meant to be a disparagement of the JavaScript Scuttlebutt ecosystem (the foundation of the entire Scuttleverse), but rather to highlight the barriers to entry for prospective client authors. It is also worth mentioning that Scuttlebutt is inherently complex and multi-faceted, regardless of language, and requires years of experience to understand.</p>
<p>In writing golgi, we have endeavoured to lower the activation energy required for client development by offering a Rust library with clear documentation and a consistent API. We wish to see a plethora of Scuttlebutt programs, each fulfilling unique needs and evoking diverse aesthetics. It is our hope that curious tinkers and hackers alike will find golgi to be a useful tool for bringing their Scuttlebutt projects to life.</p>
<h2>Thanks</h2>
<p>This project would not have been possible were it not for the tremendous work of the <a href="https://github.com/sunrise-choir">Sunrise Choir</a> and the <a href="https://github.com/Kuska-ssb">Kuska-ssb</a> authors.</p>
<h2>Authors</h2>
<ul style="padding: 0;">
<li class="list-item">notplants: <a href="mailto:max@mfowler.info" title="notplants' Email address">max@mfowler.info</a></li>