|
1 | | -# Zotero AI Newton |
| 1 | +# 🚀 Zotero AI Newton |
2 | 2 |
|
3 | | -[](https://www.zotero.org) |
| 3 | +<div align="center"> |
| 4 | + [](https://www.zotero.org) |
| 5 | + [](https://github.com/newtontech/Zotero-AI-Newton) |
| 6 | + [](LICENSE) |
| 7 | + [](release/zotero-ai-newton-0.0.1-beta.xpi) |
| 8 | +</div> |
4 | 9 |
|
5 | | -Zotero AI Newton brings a Bohrium-inspired knowledge workspace directly into Zotero. It lets you chat with a single item, attached PDFs, or an entire collection using your preferred LLM provider while keeping all data local to your library. |
| 10 | +<div align="center">[English](README.md) | [简体中文](release/README-zhCN.md)</div> |
6 | 11 |
|
7 | | -## Features |
| 12 | +> **Transform your Zotero into an AI-powered knowledge hub!** 💥 |
| 13 | +> Chat with items, PDFs, or entire collections using OpenAI, DeepSeek, or custom LLMs. All data stays local. No more fragmented notes—unlock seamless AI research! |
8 | 14 |
|
9 | | -- **Local knowledge workspace**: multi-turn chat that remembers history and mirrors your current Zotero selection. |
10 | | -- **PDF-aware answers**: summarize and question PDFs linked to selected items. |
11 | | -- **Collection reasoning**: compare or combine insights across folders before sending prompts to an LLM. |
12 | | -- **Pluggable models**: supply OpenAI or DeepSeek API keys and models from the preferences pane. |
13 | | -- **Tone controls**: switch between concise, detailed, or creative responses without changing prompts. |
14 | 15 |
|
15 | | -## Installation |
16 | 16 |
|
17 | | -### Quick install (prebuilt 0.0.1-beta) |
| 17 | +## ✨ Killer Features |
18 | 18 |
|
19 | | -1. Download the signed XPI from the `release` folder (no build needed): |
20 | | - - From this repository: [`release/zotero-ai-newton-0.0.1-beta.xpi`](release/zotero-ai-newton-0.0.1-beta.xpi) |
21 | | - - Direct raw link: https://raw.githubusercontent.com/newtontech/Zotero-AI-Newton/main/release/zotero-ai-newton-0.0.1-beta.xpi |
22 | | -2. In Zotero, open **Tools → Add-ons**, choose **Install Add-on From File…**, and select the downloaded XPI. |
23 | | -3. Automatic beta updates are served from `release/update-beta.json`, so you can stay on the beta channel without rebuilding. |
| 19 | +- 🧠 **AI Knowledge Workspace**: Multi-turn chats with full history, auto-syncing your Zotero selection |
| 20 | +- 📄 **PDF Superpowers**: Instant summaries & Q&A on attached PDFs |
| 21 | +- 📂 **Collection Intelligence**: Aggregate & reason across folders before LLM calls |
| 22 | +- 🔌 **Model Agnostic**: OpenAI, DeepSeek, or custom—plug in your API key & model |
| 23 | +- 🎨 **Tone Mastery**: Concise, detailed, or creative responses at the flip of a switch |
24 | 24 |
|
25 | | -### Post-install setup |
| 25 | +## 🚀 Lightning-Fast Install (Prebuilt Beta) |
26 | 26 |
|
27 | | -1. Open **Edit → Preferences → Zotero AI Newton**. |
28 | | -2. Paste your **OpenAI** or **DeepSeek** API key and preferred model. |
29 | | -3. Pick the default conversation scope (auto/item/collection) and response tone, then save. |
30 | | -4. Ensure Zotero can reach the internet so the plugin can call your chosen LLM provider. |
| 27 | +1. 🎯 **[Download XPI Now](release/zotero-ai-newton-0.0.1-beta.xpi)** – No build required! |
| 28 | +2. Zotero: **Tools → Add-ons → Install Add-on From File** → Pick the XPI |
| 29 | +3. ✅ **Auto-Updates** via `release/update-beta.json` – Stay on bleeding edge! |
31 | 30 |
|
32 | | -### Build from source |
33 | 31 |
|
34 | | -1. Install Node.js LTS and a Zotero 7 build. |
35 | | -2. Clone this repository and install dependencies: |
36 | | - ```sh |
37 | | - npm install |
38 | | - ``` |
39 | | -3. Build the XPI package: |
40 | | - ```sh |
41 | | - npm run build |
42 | | - ``` |
43 | | - The compiled add-on will appear under `.scaffold/build`. |
44 | | -4. In Zotero, open **Tools → Add-ons**, choose **Install Add-on From File…**, and select the generated XPI. |
45 | 32 |
|
46 | | -## Configuration |
| 33 | +### ⚙️ 2-Min Setup |
47 | 34 |
|
48 | | -Open **Edit → Preferences → Zotero AI Newton** to choose your provider (OpenAI/DeepSeek/custom), API base URL, key, default model, conversation scope (item, collection, or auto), and response tone. These settings stay local to Zotero and are used by the AI workspace pane and menu action. |
| 35 | +1. **Edit → Preferences → Zotero AI Newton** |
| 36 | +2. Enter your **OpenAI/DeepSeek API key** + model |
| 37 | +3. Choose scope (auto/item/collection) & tone → **Save** |
| 38 | +4. Go online – You're AI-ready! 🚀 |
49 | 39 |
|
50 | | -## Usage |
| 40 | +### 🔨 Build from Source (Devs) |
51 | 41 |
|
52 | | -- Select one or more items or a collection and open the **AI Workspace** section in the item pane to review the current context. |
53 | | -- Open the **Zotero AI Newton** sidebar in the right panel (or use the item menu entry) to start a multi-turn conversation that follows your current selection and attached PDFs. |
54 | | -- Refresh the context snapshot whenever you change selections or folders. |
| 42 | +```bash |
| 43 | +git clone https://github.com/newtontech/Zotero-AI-Newton |
| 44 | +cd Zotero-AI-Newton |
| 45 | +npm install |
| 46 | +npm run build # → .scaffold/build/*.xpi |
| 47 | +``` |
55 | 48 |
|
56 | | -## Development |
| 49 | +Install the XPI as above. Hot-reload: `npm run start` 🔥 |
57 | 50 |
|
58 | | -- Hot reload during development: |
59 | | - ```sh |
60 | | - npm run start |
61 | | - ``` |
62 | | -- Lint and format checks: |
63 | | - ```sh |
64 | | - npm run lint:check |
65 | | - ``` |
66 | | -- Build before submitting changes: |
67 | | - ```sh |
68 | | - npm run build |
69 | | - ``` |
| 51 | +## ⚙️ Customize Your AI |
70 | 52 |
|
71 | | -Contributions that extend the AI workflows (better context gathering, richer prompts, additional model providers) are welcome. |
| 53 | +**Edit → Preferences → Zotero AI Newton**: Pick provider, API URL/key, model, scope & tone. All local, zero telemetry! 🔒 |
| 54 | + |
| 55 | +## 🎯 Get Started in Seconds |
| 56 | + |
| 57 | +- Select items/collection → **AI Workspace** tab for context preview |
| 58 | +- Open **Zotero AI Newton** sidebar (or right-click menu) → Chat away! 💬 |
| 59 | +- 🔄 Refresh context on selection changes |
| 60 | + |
| 61 | +## 👨💻 Dev Mode |
| 62 | + |
| 63 | +```bash |
| 64 | +npm run start # 🌡️ Hot reload |
| 65 | +npm run lint:check # 🔍 Code quality |
| 66 | +npm run build # 📦 Release XPI |
| 67 | +``` |
| 68 | + |
| 69 | +## 🌟 Join the Revolution |
| 70 | + |
| 71 | +⭐ **Star us** on GitHub! |
| 72 | +🤝 **Contribute**: Better prompts, new models, PDF magic? PRs welcome! |
| 73 | +💬 **Feedback**: Issues or Discord soon... |
| 74 | + |
| 75 | +**Made with ❤️ for researchers worldwide.** |
0 commit comments