Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.6 KB

File metadata and controls

54 lines (37 loc) · 1.6 KB

Readied

Markdown-first, offline-forever desktop note app.

License: MIT Release

About

This repository contains the open-source core of Readied. Core packages are licensed under MIT for community use and contributions. The desktop application and some commercial features remain proprietary.

Quick Start

# Clone
git clone https://github.com/tomymaritano/readide.git
cd readide

# Install
pnpm install

# Run
pnpm dev

Open Source Packages

Package Description
@readied/core Domain logic, markdown parsing
@readied/storage-core Storage interfaces
@readied/storage-sqlite SQLite implementation
@readied/wikilinks Wikilink parsing
@readied/tasks Task/checkbox parsing
@readied/commands Command palette
@readied/embeds Image/embed handling
@readied/plugin-api Plugin API + theme system

Contributing

See CONTRIBUTING.md for guidelines.

Links

License

  • Core packages: MIT License
  • Desktop app: Proprietary

See LICENSE for details.