flonat-research 0.1.0 → 0.1.1

package/README.md

@@ -6,9 +6,22 @@ Made by a humble PhD student. A complete Claude Code infrastructure for research
 
 Works on **macOS, Linux, and Windows**. Use Claude Code from the [terminal CLI](https://docs.anthropic.com/en/docs/claude-code), [VS Code](https://marketplace.visualstudio.com/items?itemName=anthropics.claude-code), [JetBrains IDEs](https://plugins.jetbrains.com/plugin/27189-claude-code), [the web](https://claude.ai/code), or the [desktop app](https://claude.ai/download) — all share the same skills, agents, and rules.
 
+[![npm version](https://img.shields.io/npm/v/flonat-research)](https://www.npmjs.com/package/flonat-research)
+[![GitHub release](https://img.shields.io/github/v/release/flonat/claude-research)](https://github.com/flonat/claude-research/releases)
+
 ## Installation
 
-### macOS / Linux
+### Quick Install (npm)
+
+```bash
+npx flonat-research
+```
+
+This downloads the package and runs the setup script, which symlinks skills, agents, hooks, and rules into `~/.claude/`.
+
+### Full Install (recommended for customisation)
+
+#### macOS / Linux
 
 ```bash
 git clone https://github.com/flonat/claude-research.git
@@ -16,7 +29,7 @@ cd claude-research
 ./scripts/setup.sh
 ```
 
-### Windows (PowerShell)
+#### Windows (PowerShell)
 
 ```powershell
 git clone https://github.com/flonat/claude-research.git
@@ -24,6 +37,8 @@ cd claude-research
 .\scripts\setup.ps1
 ```
 
+The git clone gives you a local copy you can fully customise — edit `.context/profile.md`, `CLAUDE.md`, and workflows to match your research.
+
 ### Update
 
 ```bash

package/docs/getting-started.md

@@ -84,7 +84,21 @@ Python is required for several hooks (context monitor, compact save/restore) and
 
 ## Installation
 
-### macOS / Linux
+### Quick Install (npm)
+
+If you have Node.js 18+ installed:
+
+```bash
+npx flonat-research
+```
+
+This downloads the package, runs the setup script, and symlinks skills, agents, hooks, and rules into `~/.claude/`. Good for trying it out quickly.
+
+> **Note:** The npm install places files inside `node_modules/`. For full customisation (editing context files, adding your own skills), use the git clone method below.
+
+### Full Install (recommended for customisation)
+
+#### macOS / Linux
 
 ```bash
 git clone https://github.com/flonat/claude-research.git
@@ -92,7 +106,7 @@ cd claude-research
 ./scripts/setup.sh
 ```
 
-### Windows
+#### Windows
 
 Open **PowerShell** (not Command Prompt) and run:
 
@@ -114,6 +128,16 @@ The setup script creates links in `~/.claude/` so Claude Code can find your skil
 4. Checks that Python, uv, Git, and LaTeX are installed
 5. Creates `log/` directories for session continuity
 
+### Update
+
+```bash
+# macOS/Linux: pull latest, then re-link without overwriting settings
+git pull && ./scripts/setup.sh --update
+
+# Windows (PowerShell):
+git pull; .\scripts\setup.ps1 -Update
+```
+
 ## Linux Notes
 
 Linux is the most straightforward platform — hooks run natively and paths work out of the box. A few things to check:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flonat-research",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Claude Code infrastructure for academic research — skills, agents, hooks, and rules for LaTeX, bibliography, proofreading, and project management workflows.",
   "author": "Florian Burnat",
   "license": "MIT",
@@ -22,10 +22,10 @@
     "hooks"
   ],
   "bin": {
-    "claude-research-setup": "scripts/setup.sh"
+    "flonat-research": "scripts/setup.sh"
   },
   "scripts": {
-    "postinstall": "echo '\\nRun: npx claude-research-setup\\nto create symlinks for skills, agents, hooks, and rules.\\n'",
+    "postinstall": "echo '\\nRun: npx flonat-research\\nto create symlinks for skills, agents, hooks, and rules.\\n'",
     "setup": "bash scripts/setup.sh"
   },
   "files": [