docs: add link to hosted API documentation

This commit is contained in:
David Snelling 2026-01-26 14:22:18 -08:00
parent 2ee6a049a6
commit f8ef0a0536

View file

@ -6,6 +6,7 @@
[![npm version](https://badge.fury.io/js/%40soulcraft%2Fbrainy.svg)](https://www.npmjs.com/package/@soulcraft/brainy) [![npm version](https://badge.fury.io/js/%40soulcraft%2Fbrainy.svg)](https://www.npmjs.com/package/@soulcraft/brainy)
[![npm downloads](https://img.shields.io/npm/dm/@soulcraft/brainy.svg)](https://www.npmjs.com/package/@soulcraft/brainy) [![npm downloads](https://img.shields.io/npm/dm/@soulcraft/brainy.svg)](https://www.npmjs.com/package/@soulcraft/brainy)
[![Documentation](https://img.shields.io/badge/docs-soulcraft.com-blue.svg)](https://soulcraft.com/docs)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/) [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
@ -37,10 +38,10 @@ await brain.init()
**New to Brainy? Pick your starting point:** **New to Brainy? Pick your starting point:**
### 🚀 Path 1: I want to build something NOW ### 🚀 Path 1: I want to build something NOW
**→ [Complete API Reference](docs/api/README.md)** ⭐ **Most developers start here** **→ [Full Documentation](https://soulcraft.com/docs)** ⭐ **Most developers start here**
- Every method documented with examples - Interactive API reference with examples
- Quick start in 60 seconds - Quick start guides and tutorials
- 1,870 lines of copy-paste ready code - Copy-paste ready code snippets
- **This is your primary resource** - **This is your primary resource**
### 🧠 Path 2: I want to understand the big picture first ### 🧠 Path 2: I want to understand the big picture first