@verkstedt/swimlanes
v1.0.5
Published
Open sequence diagrams stored in text files on https://swimlanes.io
Downloads
8
Readme
@verkstedt/swimlanes
Installation
npm install -g @verkstedt/swimlanes
Usage
Encode text (opens browser by default):
swimlanes [OPTIONS] TEXT
echo TEXT | swimlanes [OPTIONS]
Encode text stored in a file:
swimlanes [OPTIONS] --file FILE
Decode URL or a hash into text:
swimlanes --decode URL|HASH
Options:
--decode, -d Decode hash (by default we encode text)
--no-open, -n Do not open a browser after encoding text, just print the URL
--file, -f Read input from a file
API
import {
createSwimlanesHash,
createSwimlanesUrl,
decodeSwimlanesHash,
decodeSwimlanesUrl
} from '@verkstedt/swimlanes'
createSwimlanesHash('title: Hello World') // → K8ksyUm1UvBIzcnJVwjPL8pJAQA=
createSwimlanesUrl('title: Hello World').toString() // → https://swimlanes.io/#K8ksyUm1UvBIzcnJVwjPL8pJAQA=
decodeSwimlanesHash('K8ksyUm1UvBIzcnJVwjPL8pJAQA=') // → title: Hello World
decodeSwimlanesUrl(new URL('https://swimlanes.io/#K8ksyUm1UvBIzcnJVwjPL8pJAQA=')) // → title: Hello World
License
Copyright 2022 Verkstedt [email protected]. Licensed under ISC license.