glyph
/
lykin
0
1
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

update docs with quickstart and documentation sections

This commit is contained in:
glyph 2022-08-11 11:57:39 +01:00
parent 29237bcf12
commit 168783a028
2 changed files with 51 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -6,6 +6,23 @@ _Symbiosis of SSB, key-value store and web server._
lykin is a tutorial application funded by a Secure Scuttlebutt (SSB) community grant. It is intended to showcase one way in which an SSB application can be written using the [golgi](http://golgi.mycelial.technology) client library. The application is not intended for widespread or longterm use and will not be maintained as such; it is purely for demonstration purposes. Anyone is free to fork the repository and use it as the basis for their own application.
## Quickstart
Prerequisites: a running instance of go-sbot (see the [installation guide](https://github.com/ssbc/go-ssb#installation)).
Download, build and run lykin.
```
git clone https://git.coopcloud.tech/glyph/lykin.git
cd lykin
cargo build --release
RUST_LOG=lykin=info ./target/release/lykin
```
Open `localhost:8000` in your browser.
**Note**: by default, lykin attempts to connect to the go-sbot instance on port 8021. Set the `GO_SBOT_PORT` environment variable if you wish to use another port.
## Features
lykin presents an email inbox-like UI and functions as a Scuttlebutt reader application. It allows the user to subscribe to peers and read the root posts of those peers. Individual posts can be marked as read or unread.
@ -30,6 +47,12 @@ lykin has been built with the following components:
- [sled](https://crates.io/crates/sled) : transactional embedded database (key-value store)
- [sbot](https://github.com/cryptoscope/ssb) : Scuttlebutt server (in our case, go-ssb)
## Documentation
This project is documented in the form of code comments and Rust doc comments. In order to generate and read the doc comments in a web browser, run the following command in the lykin repo:
`cargo doc --open --no-deps`
## Thanks
I am grateful to the Butts who voted to fund this work, all contributors to the SSBC and Erick Lavoie in particular - both for partially funding this work and for developing and overseeing the community grant process.

28
src/main.rs
View File

@ -14,6 +14,26 @@
//! as such; it is purely for demonstration purposes. Anyone is free to fork
//! the repository and use it as the basis for their own application.
//!
//! ## Quickstart
//!
//! Prerequisites: a running instance of go-sbot (see the [installation
//! guide](https://github.com/ssbc/go-ssb#installation)).
//!
//! Download, build and run lykin.
//!
//! ```
//! git clone https://git.coopcloud.tech/glyph/lykin.git
//! cd lykin
//! cargo build --release
//! RUST_LOG=lykin=info ./target/release/lykin
//! ```
//!
//! Open `localhost:8000` in your browser.
//!
//! **Note**: by default, lykin attempts to connect to the go-sbot instance on
//! port 8021. Set the `GO_SBOT_PORT` environment variable if you wish to use
//! another port.
//!
//! ## Features
//!
//! lykin presents an email inbox-like UI and functions as a Scuttlebutt reader
@ -42,6 +62,14 @@
//! - [sbot](https://github.com/cryptoscope/ssb) : Scuttlebutt server (in our
//! case, go-ssb)
//!
//! ## Documentation
//!
//! This project is documented in the form of code comments and Rust doc
//! comments. In order to generate and read the doc comments in a web browser,
//! run the following command in the lykin repo:
//!
//! `cargo doc --open --no-deps`
//!
//! ## Thanks
//!
//! I am grateful to the Butts who voted to fund this work, all contributors to