readme some videos

This commit is contained in:
Taylor Hulsmans 2023-09-26 09:35:52 -04:00
parent 5504e3e441
commit 20a312efc4
3 changed files with 19 additions and 1 deletions

View file

@ -1,6 +1,10 @@
# Obsidian Lilypad
This is a [desci nodes](https://desci.com/), [lilypad](https://docs.lilypadnetwork.org/lilypad-v1-testnet/overview), [kamu](https://www.kamu.dev/) and [ipfs helia](https://github.com/ipfs/helia) plugin for Obsidian (https://obsidian.md).
[Video Demo](https://www.youtube.com/watch?v=DS2e0smviRA&ab_channel=TaylorHulsmans)
Pull Desci nodes, stream together external apis, run edge compute jobs by calling smart contracts, and fetch from ipfs all from the obsidian canvas.
The science tech stacks is due for an upgrade to enable collaboration and composability within an interface that is familiar and easy to understand. Obsidian Lilypad ties together technologies from the emerging decentralized science ecosystem
@ -9,14 +13,18 @@ Targeting enabling a composition pipeline for scientists that builds into their
**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
### Config
-
- Private Key - a private key for an ethereum address that has lil ETH on the lalechuza testnet
- Delegate Kubo - speed up pulling from ipfs by delegating content routing through a kubo node one runs separately in a terminal
### Commands
In a canvas, select a node and run hit Ctrl-P to search for
- Desci - pull a desci node from beta.dpid.org
- runCowsay - execute cowsay on the content of a canvas node
- getDpid - pull a desci node from beta.dpid.org
- runSDXL - run stable diffusion by executing a transation through lilypad
- ipfsCAT - pull the content from a CID from ipfs
- ipfsDagGet - pull a cid that references a dag and splay the child CIds into nodes
- ipfsAdd - Add a json object referenced by a CID
## How to use
@ -24,10 +32,20 @@ In a canvas, select a node and run hit Ctrl-P to search for
- Make sure your NodeJS is at least v16 (`node --version`).
- `npm i` or `yarn` to install dependencies.
- `npm run dev` to start compilation in watch mode.
- `cd ./api` `npm i` and `npm run start` enables the restful api that handles IPFS helia
- In obsidian hit Ctrl-P and type 'open settings'
- enable community plugins
- find obsidian-lilypad in the menu (may need to hit refresh to see it)
- hit the gear to open obsidian-lilypad settings, and add private key that has LILETH on the lalechuza testnet
### add to community plugins
![output](https://github.com/polus-arcticus/obsidian-lilypad/assets/122753557/76b74cfb-1e0b-4c72-9b2a-5b2a163b5399)
### In the Future
- IpfsDagify - create a Dag of connected canvas nodes and upload to ipfs
- IPFSremotePin - pin content by an external provider
- runKamu - create a custom lilypad job that merges the contents of two cids that reference a database
```json
{
"fundingUrl": "joe-mcgee.radicle.eth"

BIN
dag-cat-1.webm Normal file

Binary file not shown.

BIN
sdxl-lilypad-1.webm Normal file

Binary file not shown.