Skip to content

Commit ccd8104

Browse files
author
Codex Agent
committed
feat: update README and move Chinese README to release folder
1 parent 3a2bcad commit ccd8104

3 files changed

Lines changed: 57 additions & 106 deletions

File tree

README.md

Lines changed: 57 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,75 @@
1-
# Zotero AI Newton
1+
# 🚀 Zotero AI Newton
22

3-
[![zotero target version](https://img.shields.io/badge/Zotero-7-green?style=flat-square&logo=zotero&logoColor=CC2936)](https://www.zotero.org)
3+
<div align="center">
4+
[![Zotero](https://img.shields.io/badge/Zotero-7-green?style=flat-square&logo=zotero&logoColor=CC2936)](https://www.zotero.org)
5+
[![Stars](https://img.shields.io/github/stars/newtontech/Zotero-AI-Newton?style=social)](https://github.com/newtontech/Zotero-AI-Newton)
6+
[![License](https://img.shields.io/github/license/newtontech/Zotero-AI-Newton?style=flat-square)](LICENSE)
7+
[![Beta](https://img.shields.io/badge/version-0.0.1-beta-orange?style=flat-square)](release/zotero-ai-newton-0.0.1-beta.xpi)
8+
</div>
49

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>
611

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!
814
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.
1415

15-
## Installation
1616

17-
### Quick install (prebuilt 0.0.1-beta)
17+
## ✨ Killer Features
1818

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
2424

25-
### Post-install setup
25+
## 🚀 Lightning-Fast Install (Prebuilt Beta)
2626

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!
3130

32-
### Build from source
3331

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.
4532

46-
## Configuration
33+
### ⚙️ 2-Min Setup
4734

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! 🚀
4939

50-
## Usage
40+
### 🔨 Build from Source (Devs)
5141

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+
```
5548

56-
## Development
49+
Install the XPI as above. Hot-reload: `npm run start` 🔥
5750

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
7052

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.**

doc/README-frFR.md

Lines changed: 0 additions & 53 deletions
This file was deleted.
File renamed without changes.

0 commit comments

Comments
 (0)