updated README.md with a little bit more context and link to chat agent
This commit is contained in:
parent
93efb94514
commit
08ae9b7421
115
README.md
115
README.md
@ -1,2 +1,113 @@
|
|||||||
# Inspiration-app
|
# Inspiration Engine
|
||||||
This is a repo dedicated to the storing of information and ideation solely focused on the *inspiration app*
|
> *Inspiration Engine — your private creative memory. Search by idea, not filename.*
|
||||||
|
|
||||||
|
**A private, open-source creative memory system for organizing, searching, and reusing your inspiration.**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**[Chat with this repository](https://n8n.biohazardvfx.com/webhook/027eb8bf-1217-4bbb-8189-6ec99023a53a/chat)**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Vision
|
||||||
|
|
||||||
|
To create the **interoperability layer for creative memory** — an open ecosystem where creators, developers, and AI tools can manage creative assets seamlessly and privately.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Why It’s Different
|
||||||
|
|
||||||
|
Most bookmarking apps trade convenience for privacy.
|
||||||
|
**Inspiration Engine** is built for creative professionals who manage massive visual libraries and need **security, flexibility, and intelligence**.
|
||||||
|
|
||||||
|
### Key Advantages
|
||||||
|
- **End-to-End Encryption** — all processing happens on your device.
|
||||||
|
- **Bring-Your-Own Storage** — local disk, S3, Nextcloud, or any provider.
|
||||||
|
- **Multimodal Search** — semantic and visual search across text, images, video, and audio.
|
||||||
|
- **Open Standards** — powered by **OCMS** (Open Creative Memory Spec) and **CRQL** (Creative Retrieval Query Language).
|
||||||
|
- **Native Ingest** — direct connectors for major social and creative platforms.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Core Features
|
||||||
|
|
||||||
|
- **Semantic Search** — find ideas, not filenames.
|
||||||
|
- **Private Creative OS** — full data ownership and portability.
|
||||||
|
- **AI Intelligence** — automatic tagging, clustering, and relationship mapping.
|
||||||
|
- **Multimodal Asset Support** — images, video, audio, and documents.
|
||||||
|
- **Developer API** — OpenAPI spec with SDKs in TypeScript, Python, Swift, and Kotlin.
|
||||||
|
- **Freemium Model** — open core, with optional team and API tiers.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Architecture & Open Source Stack
|
||||||
|
|
||||||
|
| Layer | Description |
|
||||||
|
|:------|:-------------|
|
||||||
|
| **OCMS** | Defines asset + metadata schema for creative memory. |
|
||||||
|
| **CRQL** | Query language for semantic and visual search. |
|
||||||
|
| **Local Indexer** | On-device runtime with OCR and vision embeddings. |
|
||||||
|
| **Storage Adapters** | Support for S3, WebDAV, SMB, Nextcloud, or local disk. |
|
||||||
|
| **Reference Server** | Stateless API backed by PostgreSQL + vector store. |
|
||||||
|
| **E2EE Media Envelope** | Client-side encryption for assets and embeddings. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Target Audience
|
||||||
|
|
||||||
|
- Designers, filmmakers, artists, photographers
|
||||||
|
- Developers building creative or AI tools
|
||||||
|
- Content teams managing large inspiration libraries
|
||||||
|
- Anyone who wants a **private, searchable creative archive**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Competitive Advantage
|
||||||
|
|
||||||
|
| Competitor | Limitation | Inspiration Engine |
|
||||||
|
|:------------|:------------|:--------------------|
|
||||||
|
| **Raindrop.io** | Cloud-only, text-based search | E2EE + multimodal |
|
||||||
|
| **Milanote** | Closed ecosystem | Open standards (OCMS / CRQL) |
|
||||||
|
| **Pinterest** | Public by default | 100% private |
|
||||||
|
| **Cloud drives** | File-based, not idea-based | Semantic + visual search |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
### For Users
|
||||||
|
1. Install the desktop, web, or mobile app.
|
||||||
|
2. Connect your social or cloud accounts.
|
||||||
|
3. Save your inspiration.
|
||||||
|
4. Search using natural language or visual concepts.
|
||||||
|
|
||||||
|
### For Developers
|
||||||
|
1. Review the [OpenAPI specification](docs/openapi.md).
|
||||||
|
2. Explore SDKs in [TypeScript](packages/ts-sdk), [Python](packages/python-sdk), [Swift](packages/swift-sdk), and [Kotlin](packages/kotlin-sdk).
|
||||||
|
3. Contribute to the [Reference Server](packages/reference-server).
|
||||||
|
4. Build new platform connectors with the [Connector SDK](packages/connector-sdk).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Community & Contribution
|
||||||
|
|
||||||
|
We welcome contributions to the open-source ecosystem:
|
||||||
|
- Submit feature requests and bug reports
|
||||||
|
- Contribute to specifications (OCMS, CRQL)
|
||||||
|
- Build integrations for new platforms
|
||||||
|
- Improve documentation and examples
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
| Component | License |
|
||||||
|
|:-----------|:----------|
|
||||||
|
| Code | Apache 2.0 |
|
||||||
|
| Specifications | Creative Commons BY |
|
||||||
|
| Examples / Fixtures | CC BY or CC0 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
> *Inspiration Engine — your private creative memory. Search by idea, not filename.*
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user