aiolabs/bitspire
9
0
Fork 0
Code Issues 52 Pull requests 2 Projects Releases Packages Wiki Activity Actions

Add package READMEs for all packages #14

New issue
Open
opened 2026-06-13 22:02:45 +00:00 by padreug · 0 comments
padreug commented 2026-06-13 22:02:45 +00:00
Owner
Copy link

Migrated from aiolabs/lamassu-next#14 — opened by @padreug on 2026-01-26.\n\n## Problem

None of the packages have README.md files. Developers must read source code or CLAUDE.md to understand package purposes.

Missing READMEs

  • packages/nostr-client/README.md
  • packages/clink/README.md
  • packages/lightning/README.md
  • packages/state-machine/README.md
  • packages/hal/README.md
  • packages/cashu/README.md (can note placeholder status)
  • packages/ui-shared/README.md (can note placeholder status)
  • apps/machine/README.md

Each README Should Include

  1. Package purpose - One paragraph description
  2. Installation - pnpm add @lamassu/xxx
  3. Basic usage - Code example
  4. API overview - Key exports
  5. Related docs - Link to TROUBLESHOOTING.md for lightning, etc.

Example Template

# @lamassu/nostr-client

Nostr client library with NIP-42 authentication and NIP-44 encryption for Lamassu ATM communication.

## Installation

\`\`\`bash
pnpm add @lamassu/nostr-client
\`\`\`

## Usage

\`\`\`typescript
import { NostrClient, createIdentity } from '@lamassu/nostr-client'

const identity = createIdentity()
const client = new NostrClient({ relays: ['wss://relay.example.com'] })
await client.connect()
\`\`\`

## API

- `NostrClient` - Main client class
- `createIdentity()` - Generate new keypair
- `encryptNIP44()` / `decryptNIP44()` - Encryption utilities

## Tests

\`\`\`bash
pnpm test
\`\`\`

Priority

P3 - Documentation improvement, not blocking

> _Migrated from [aiolabs/lamassu-next#14](https://git.atitlan.io/aiolabs/lamassu-next/issues/14) — opened by @padreug on 2026-01-26._\n\n## Problem None of the packages have README.md files. Developers must read source code or CLAUDE.md to understand package purposes. ## Missing READMEs - [ ] `packages/nostr-client/README.md` - [ ] `packages/clink/README.md` - [ ] `packages/lightning/README.md` - [ ] `packages/state-machine/README.md` - [ ] `packages/hal/README.md` - [ ] `packages/cashu/README.md` (can note placeholder status) - [ ] `packages/ui-shared/README.md` (can note placeholder status) - [ ] `apps/machine/README.md` ## Each README Should Include 1. **Package purpose** - One paragraph description 2. **Installation** - `pnpm add @lamassu/xxx` 3. **Basic usage** - Code example 4. **API overview** - Key exports 5. **Related docs** - Link to TROUBLESHOOTING.md for lightning, etc. ## Example Template ```markdown # @lamassu/nostr-client Nostr client library with NIP-42 authentication and NIP-44 encryption for Lamassu ATM communication. ## Installation \`\`\`bash pnpm add @lamassu/nostr-client \`\`\` ## Usage \`\`\`typescript import { NostrClient, createIdentity } from '@lamassu/nostr-client' const identity = createIdentity() const client = new NostrClient({ relays: ['wss://relay.example.com'] }) await client.connect() \`\`\` ## API - `NostrClient` - Main client class - `createIdentity()` - Generate new keypair - `encryptNIP44()` / `decryptNIP44()` - Encryption utilities ## Tests \`\`\`bash pnpm test \`\`\` ``` ## Priority P3 - Documentation improvement, not blocking
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
dev
feat/rpi4-target
feat/rpi5-apex-hal
fix/sintra-timezone
wip/rpi4-sketch
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
aiolabs/bitspire#14
No description provided.