From d4306d94ecf6bd02c0210a6c98ca71ab0f07deef Mon Sep 17 00:00:00 2001 From: glyph Date: Mon, 15 Aug 2022 12:14:23 +0100 Subject: [PATCH] update root readme --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..21a67d3 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Lykin Tutorial Series + +## Introduction + +[lykin](https://git.coopcloud.tech/glyph/lykin) is a tutorial application funded by a Secure Scuttlebutt (SSB) community grant. It is intended to showcase one way in which an SSB client application can be written using the [golgi](https://git.coopcloud.tech/golgi-ssb/golgi) client library. This tutorial series walks the reader through the creation of the lykin application. + +## Installments + + - [Part 1: Sbot and Web Server](https://git.coopcloud.tech/glyph/lykin_tutorial/src/branch/main/part_1_sbot_rocket) + +## Thanks + +I am grateful to the Butts who voted to fund this work, all contributors to the [SSBC](https://opencollective.com/secure-scuttlebutt-consortium) and Erick Lavoie (`@elavoie` / `@IgYpd+tCtXnlE2tYX/8rR2AGt+P8svC98WH3MdYAa8Y=.ed25519`) in particular - both for partially funding this work and for developing and overseeing the community grant process. + +## Contribute + +If you wish to support my work on the Rust Scuttlebutt ecosystem, please consider contributing to my [Liberapay account](https://liberapay.com/glyph/). + +Contributions to the [Secure Scuttlebutt Consortium OpenCollective](https://opencollective.com/secure-scuttlebutt-consortium) are also encouraged. + +## License + +This tutorial series is shared under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)](https://creativecommons.org/licenses/by-nc-sa/4.0/) license, while all code is licensed as MIT.